From 4a07fbf87c5aebb8a5ada0e5a6ff5a64615738f4 Mon Sep 17 00:00:00 2001 From: lucie-tirand Date: Fri, 31 Oct 2025 12:04:03 +0100 Subject: [PATCH 1/3] remove coming soon in metrics page 1 on 3 CTOR-1944 --- .../procedures/applications-mscs-nrpe.md | 35 +- .../cloud-azure-compute-virtualmachine.md | 9 +- .../hardware-storage-avid-isis-snmp.md | 30 +- .../procedures/network-3com-snmp.md | 13 +- .../procedures/network-dlink-standard-snmp.md | 19 +- ...etwork-firewalls-paloalto-standard-snmp.md | 668 +++++++++-------- ...network-firewalls-paloalto-standard-ssh.md | 21 +- .../procedures/network-firewalls-stonesoft.md | 669 ++++++++--------- .../procedures/network-hp-vc-snmp.md | 24 +- ...network-switchs-alcatel-omniswitch-snmp.md | 499 +++++++------ .../procedures/applications-mscs-nrpe.md | 35 +- .../cloud-azure-compute-virtualmachine.md | 9 +- .../hardware-storage-avid-isis-snmp.md | 30 +- .../procedures/network-3com-snmp.md | 33 +- .../procedures/network-dlink-standard-snmp.md | 19 +- ...etwork-firewalls-paloalto-standard-snmp.md | 659 +++++++++-------- ...network-firewalls-paloalto-standard-ssh.md | 21 +- .../procedures/network-firewalls-stonesoft.md | 692 +++++++++--------- .../procedures/network-hp-vc-snmp.md | 24 +- ...network-switchs-alcatel-omniswitch-snmp.md | 502 +++++++------ 20 files changed, 2188 insertions(+), 1823 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-mscs-nrpe.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-mscs-nrpe.md index 8116ab9430d9..2e660e1fd7b1 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-mscs-nrpe.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-mscs-nrpe.md @@ -21,9 +21,40 @@ agent to check the health and performance of Microsoft Clusters. * Microsoft Server with the MSCS extension -### Collected metrics +### Métriques & statuts collectés -*Coming soon* +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. + + + + +| Nom | Unité | +|:-------|:------| +| status | N/A | + + + + +| Nom | Unité | +|:-------|:------| +| status | N/A | + + + + +| Nom | Unité | +|:-------|:------| +| status | N/A | + + + + +| Nom | Unité | +|:-------|:------| +| status | N/A | + + + ## Prerequisites diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/cloud-azure-compute-virtualmachine.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/cloud-azure-compute-virtualmachine.md index 6c96dcac0f06..b644537ee643 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/cloud-azure-compute-virtualmachine.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/cloud-azure-compute-virtualmachine.md @@ -119,7 +119,14 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -Coming soon +| Nom | Unité | +|:----------------------------------|:------| +| azvm.general.standard_B* | N/A | +| azvm.compute.standard_F* | N/A | +| azvm.memory.standard_E* | N/A | +| azvm.storage.standard_L* | N/A | +| azvm.gpu.standard_N* | N/A | +| azvm.high_performance.standard_H* | N/A | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-avid-isis-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-avid-isis-snmp.md index cdd77bd14287..6316d54deb7f 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-avid-isis-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-storage-avid-isis-snmp.md @@ -48,15 +48,33 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -Coming soon +| Nom | Unité | +|:-----------------------------|:------| +| hardware.alarm.status | N/A | +| hardware.alarm.count | count | +| hardware.fan.status | N/A | +| hardware.fan.count | count | +| hardware.pdrive.status | N/A | +| hardware.pdrive.count | count | +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.sim.status | N/A | +| hardware.sim.count | count | +| hardware.slot.status | N/A | +| hardware.slot.count | count | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | +| hardware.vdrive.status | N/A | +| hardware.vdrive.count | count | -| Métrique | Unité | +| Nom | Unité | |:-----------------|:-----------| -| active_clients | clients | -| open-files | files | +| active_clients | count | +| open-files | count | | processing-speed | messages/s | | read-throughput | B/s | | write-throughput | B/s | @@ -66,7 +84,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:---------------------|:------| | status | N/A | | redistributing-count | N/A | @@ -76,7 +94,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:----------------|:------| | allocated | B | | workspace-count | N/A | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-3com-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-3com-snmp.md index 0c1e26b0deba..00318619f6e1 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-3com-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-3com-snmp.md @@ -70,7 +70,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:------------------------------------|:------| | *cpu*#cpu.utilization.5s.percentage | % | | *cpu*#cpu.utilization.1m.percentage | % | @@ -81,12 +81,17 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -Coming soon +| Nom | Unité | +|:--------------------|:------| +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.fan.status | N/A | +| hardware.fan.count | count | -| Métrique | Unité | +| Nom | Unité | |:----------------------------|:------| | *memory*#memory.usage.bytes | B | @@ -95,7 +100,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------------------|:------| | *interface_name*#status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-dlink-standard-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-dlink-standard-snmp.md index 19c814af7b4f..5d69f652660c 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-dlink-standard-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-dlink-standard-snmp.md @@ -68,7 +68,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:----------------------------------------------|:------| | cpu.utilization.5s.percentage | % | | cpu.utilization.1m.percentage | % | @@ -80,12 +80,21 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -Coming soon +| Nom | Unité | +|:-----------------------------|:------| +| hardware.fan.status | N/A | +| hardware.fan.count | count | +| hardware.fan.speed.rpm | rpm | +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | -| Métrique | Unité | +| Nom | Unité | |:----------------------------------------------------------|:------| | *interface_name*#status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | @@ -98,7 +107,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:---------------------------------|:------| | *memory*#memory.usage.bytes | B | | *memory*#memory.free.bytes | B | @@ -107,7 +116,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:----------------------------|:------| | stack.members.total.count | count | | *member*~member-status | N/A | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md index 0ab82c504ce9..1a90ea5eff19 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md @@ -5,6 +5,12 @@ title: Palo Alto firewall 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 **Palo Alto firewall SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles @@ -35,7 +41,7 @@ Le connecteur apporte les modèles de service suivants |:-----------------------|:-------------------------------------------------|:---------------------------------------------|:----------:| | Cluster-Status | Net-PaloAlto-Standard-Cluster-Status-SNMP-custom | Contrôle l'état du cluster | | | Global-Protect-Tunnels | Net-PaloAlto-Standard-Global-Protect-SNMP-custom | Contrôle les tunnels GlobalProtect | | -| Interfaces | Net-PaloAlto-Standard-Interfaces-SNMP-custom | Contrôle les interfaces | X | +| Interfaces | Net-PaloAlto-Standard-Interfaces-SNMP-custom | Contrôle les interfaces | X | | Panorama | Net-PaloAlto-Standard-Panorama-SNMP-custom | Contrôle le statut des connexions 'panorama' | | | Signatures | Net-PaloAlto-Standard-Signatures-SNMP-custom | Contrôle les signatures antivirus | | @@ -48,31 +54,39 @@ Le connecteur apporte les modèles de service suivants ### Règles de découverte -#### Découverte de service +#### Découverte d'hôtes + +| Nom de la règle | Description | +|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-PaloAlto-Standard-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. -| Nom de la règle | Description | -|:------------------------------------------|:---------------------------------------------------| -| Net-PaloAlto-Standard-SNMP-Interface-Name | Découvre les interfaces et supervise l'utilisation | +#### Découverte de services + +| Nom de la règle | Description | +|:------------------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-PaloAlto-Standard-SNMP-Interface-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | +| Nom | Unité | |:-------------------------|:------| -| cluster status | | -| high-availability status | | +| cluster status | N/A | +| high-availability status | N/A | -| Métrique | Unité | +| Nom | Unité | |:-------------------------------------------|:------| | cpu.managementplane.utilization.percentage | % | | cpu.dataplane.utilization.percentage | % | @@ -80,7 +94,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:---------------------------------------|:------| | globalprotect.tunnels.usage.count | count | | globalprotect.tunnels.free.count | count | @@ -89,57 +103,61 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -Coming soon +| Nom | Unité | +|:-----------------------|:------| +| hardware.device.status | N/A | +| hardware.device.count | count | -| Métrique | Unité | +| Nom | Unité | |:----------------------------------------------------------|:------| -| interface status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | -| *interface_name*#interface.packets.in.error.percentage | % | | *interface_name*#interface.packets.in.discard.percentage | % | -| *interface_name*#interface.packets.out.error.percentage | % | +| *interface_name*#interface.packets.in.error.percentage | % | | *interface_name*#interface.packets.out.discard.percentage | % | +| *interface_name*#interface.packets.out.error.percentage | % | -| Métrique | Unité | +| Nom | Unité | |:---------------------------------|:------| | *name*#storage.space.usage.bytes | B | -> Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. - -| Métrique | Unité | -|:----------------|:------| -| panorama status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | +| status | N/A | + +> Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. -| Métrique | Unité | -|:--------------------------------------|:------| -| sessions.active.count | count | -| sessions.active.percentage | % | -| sessions.active.tcp.count | count | -| sessions.active.udp.count | count | -| sessions.active.icmp.count | count | -| vsys#vsys.sessions.active.count | count | -| vsys#vsys.sessions.active.percentage | % | -| vsys#vsys.sessions.active.tcp.count | count | -| vsys#vsys.sessions.active.udp.count | count | -| vsys#vsys.sessions.active.other.count | count | +| Nom | Unité | +|:----------------------------------------|:------| +| sessions.active.count | count | +| sessions.active.percentage | % | +| sessions.active.tcp.count | count | +| sessions.active.udp.count | count | +| sessions.active.icmp.count | count | +| *vsys*#vsys.sessions.active.count | count | +| *vsys*#vsys.sessions.active.percentage | % | +| *vsys*#vsys.sessions.active.tcp.count | count | +| *vsys*#vsys.sessions.active.udp.count | count | +| *vsys*#vsys.sessions.active.other.count | count | -| Métrique | Unité | +| Nom | Unité | |:--------------------------------------------|:------| | signature.antivirus.lastupdate.time.seconds | s | | signature.threat.lastupdate.time.seconds | s | @@ -152,7 +170,10 @@ Coming soon ### Configuration SNMP -Afin de superviser votre équipement, le SNMP v2 ou v3 doit être configuré. +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 @@ -163,10 +184,8 @@ Centreon vers le serveur supervisé. ### 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 : @@ -203,7 +222,7 @@ yum install centreon-pack-network-firewalls-paloalto-standard-snmp 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Palo Alto firewall 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 @@ -256,11 +275,11 @@ yum install centreon-plugin-Network-Firewalls-Paloalto-Standard-Snmp 3. Appliquez le modèle d'hôte **Net-PaloAlto-Standard-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 | -|:-----------------|:------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | +| 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. @@ -272,137 +291,135 @@ yum install centreon-plugin-Network-Firewalls-Paloalto-Standard-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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 | -|:------------------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | | 80 | | -| CRITICAL | | 90 | | -| WARNINGDATAPLANE | Thresholds | | | -| CRITICALDATAPLANE | Thresholds | | | -| WARNINGMANAGEMENTPLANE | Thresholds | | | -| CRITICALMANAGEMENTPLANE | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGDATAPLANE | Threshold | | | +| CRITICALDATAPLANE | Threshold | | | +| WARNINGMANAGEMENTPLANE | Threshold | | | +| CRITICALMANAGEMENTPLANE | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGTUNNELSUSAGE | Thresholds | | | -| CRITICALTUNNELSUSAGE | Thresholds | | | -| WARNINGTUNNELSUSAGEFREE | Thresholds | | | -| CRITICALTUNNELSUSAGEFREE | Thresholds | | | -| WARNINGTUNNELSUSAGEPRCT | Thresholds | | | -| CRITICALTUNNELSUSAGEPRCT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGTUNNELSUSAGE | Threshold | | | +| CRITICALTUNNELSUSAGE | Threshold | | | +| WARNINGTUNNELSUSAGEFREE | Threshold | | | +| CRITICALTUNNELSUSAGEFREE | Threshold | | | +| WARNINGTUNNELSUSAGEPRCT | Threshold | | | +| CRITICALTUNNELSUSAGEPRCT | 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 | -|:-------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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 | -|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| -| UNITSTRAFFIC | Units of thresholds for the traffic (Default: 'percent\_delta') ('percent\_delta', 'bps', 'counter') | percent\_delta | | -| UNITSERROR | Units of thresholds for errors/discards (Default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter') | percent\_delta | | -| UNITSCAST | Units of thresholds for communication types (Default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter') | percent\_delta | | -| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Set the interface (number expected) ex: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGINBCAST | Thresholds | | | -| CRITICALINBCAST | Thresholds | | | -| WARNINGINDISCARD | Thresholds | | | -| CRITICALINDISCARD | Thresholds | | | -| WARNINGINERROR | Thresholds | | | -| CRITICALINERROR | Thresholds | | | -| WARNINGINMCAST | Thresholds | | | -| CRITICALINMCAST | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGINUCAST | Thresholds | | | -| CRITICALINUCAST | Thresholds | | | -| WARNINGINVOLUME | | | | -| CRITICALINVOLUME | | | | -| WARNINGOUTBCAST | Thresholds | | | -| CRITICALOUTBCAST | Thresholds | | | -| WARNINGOUTDISCARD | Thresholds | | | -| CRITICALOUTDISCARD | Thresholds | | | -| WARNINGOUTERROR | Thresholds | | | -| CRITICALOUTERROR | Thresholds | | | -| WARNINGOUTMCAST | Thresholds | | | -| CRITICALOUTMCAST | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | -| WARNINGOUTUCAST | Thresholds | | | -| CRITICALOUTUCAST | Thresholds | | | -| WARNINGOUTVOLUME | | | | -| CRITICALOUTVOLUME | | | | -| WARNINGSPEED | Thresholds | | | -| CRITICALSPEED | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (Default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| WARNINGTOTALADMINDOWN | Thresholds | | | -| CRITICALTOTALADMINDOWN | Thresholds | | | -| WARNINGTOTALADMINUP | Thresholds | | | -| CRITICALTOTALADMINUP | Thresholds | | | -| WARNINGTOTALOPERDOWN | Thresholds | | | -| CRITICALTOTALOPERDOWN | Thresholds | | | -| WARNINGTOTALOPERUP | Thresholds | | | -| CRITICALTOTALOPERUP | Thresholds | | | -| WARNINGTOTALPORT | Thresholds | | | -| CRITICALTOTALPORT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose --use-new-perfdata | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| +| UNITSTRAFFIC | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter') | percent\_delta | | +| UNITSERROR | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter') | percent\_delta | | +| UNITSCAST | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter') | percent\_delta | | +| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINBCAST | Threshold | | | +| CRITICALINBCAST | Threshold | | | +| WARNINGINDISCARD | Threshold | | | +| CRITICALINDISCARD | Threshold | | | +| WARNINGINERROR | Threshold | | | +| CRITICALINERROR | Threshold | | | +| WARNINGINMCAST | Threshold | | | +| CRITICALINMCAST | Threshold | | | +| WARNINGINTRAFFIC | Threshold | | | +| CRITICALINTRAFFIC | Threshold | | | +| WARNINGINUCAST | Threshold | | | +| CRITICALINUCAST | Threshold | | | +| WARNINGINVOLUME | Threshold | | | +| CRITICALINVOLUME | Threshold | | | +| WARNINGOUTBCAST | Threshold | | | +| CRITICALOUTBCAST | Threshold | | | +| WARNINGOUTDISCARD | Threshold | | | +| CRITICALOUTDISCARD | Threshold | | | +| WARNINGOUTERROR | Threshold | | | +| CRITICALOUTERROR | Threshold | | | +| WARNINGOUTMCAST | Threshold | | | +| CRITICALOUTMCAST | Threshold | | | +| WARNINGOUTTRAFFIC | Threshold | | | +| CRITICALOUTTRAFFIC | Threshold | | | +| WARNINGOUTUCAST | Threshold | | | +| CRITICALOUTUCAST | Threshold | | | +| WARNINGOUTVOLUME | Threshold | | | +| CRITICALOUTVOLUME | Threshold | | | +| WARNINGSPEED | Threshold | | | +| CRITICALSPEED | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| WARNINGTOTALADMINDOWN | Threshold | | | +| CRITICALTOTALADMINDOWN | Threshold | | | +| WARNINGTOTALADMINUP | Threshold | | | +| CRITICALTOTALADMINUP | Threshold | | | +| WARNINGTOTALOPERDOWN | Threshold | | | +| CRITICALTOTALOPERDOWN | Threshold | | | +| WARNINGTOTALOPERUP | Threshold | | | +| CRITICALTOTALOPERUP | Threshold | | | +| WARNINGTOTALPORT | Threshold | | | +| CRITICALTOTALPORT | 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 --use-new-perfdata | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUSAGE | Warning threshold | | | -| CRITICALUSAGE | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGUSAGE | Warning threshold | | | +| CRITICALUSAGE | 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 | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------|:-----------:| -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (Default: '%\{status\} =~ /not-connected/i'). You can use the following variables: %\{status\}, %\{display\} | %\{status\} =~ /not-connected/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{status\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------|:-----------:| +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{display\} | %\{status\} =~ /not-connected/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGACTIVE | Thresholds. Global: 'active', 'active-prct', (%), 'active-tcp', 'active-udp', 'active-icmp', Per vsys: 'vsys-active', 'vsys-active-prct' (%), 'vsys-active-tcp' 'vsys-active-udp' 'vsys-active-other' | | | -| CRITICALACTIVE | Thresholds. Global: 'active', 'active-prct', (%), 'active-tcp', 'active-udp', 'active-icmp', Per vsys: 'vsys-active', 'vsys-active-prct' (%), 'vsys-active-tcp' 'vsys-active-udp' 'vsys-active-other' | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGACTIVE | Threshold | | | +| CRITICALACTIVE | 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 | -|:-----------------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGAVUPDATE | Thresholds | | | -| CRITICALAVUPDATE | Thresholds | | | -| WARNINGTHREATUPDATE | Thresholds | | | -| CRITICALTHREATUPDATE | Thresholds | | | -| WARNINGWILDFIREUPDATE | Thresholds | | | -| CRITICALWILDFIREUPDATE | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGAVUPDATE | Threshold | | | +| CRITICALAVUPDATE | Threshold | | | +| WARNINGTHREATUPDATE | Threshold | | | +| CRITICALTHREATUPDATE | Threshold | | | +| WARNINGWILDFIREUPDATE | Threshold | | | +| CRITICALWILDFIREUPDATE | 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 | | @@ -414,7 +431,7 @@ yum install centreon-plugin-Network-Firewalls-Paloalto-Standard-Snmp Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur **centreon-engine** (`su - centreon-engine`). Vous pouvez tester -que le connecteur arrive bien à superviser un serveur en utilisant une commande +que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : ```bash @@ -453,23 +470,23 @@ Tous les modes disponibles peuvent être affichés en ajoutant le paramètre ```bash /usr/lib/centreon/plugins/centreon_paloalto.pl \ --plugin=network::paloalto::snmp::plugin \ - --list-mode + --list-mode ``` Le plugin apporte les modes suivants : -| Mode | Modèle de service associé | -|:----------------|:------------------------------------------| -| cluster-status | Net-PaloAlto-Standard-Cluster-Status-SNMP | -| cpu | Net-PaloAlto-Standard-Cpu-SNMP | -| gp-usage | Net-PaloAlto-Standard-Global-Protect-SNMP | -| hardware | Net-PaloAlto-Standard-Hardware-SNMP | -| interfaces | Net-PaloAlto-Standard-Interfaces-SNMP | -| list-interfaces | Used for service discovery | -| memory | Net-PaloAlto-Standard-Memory-SNMP | -| panorama | Net-PaloAlto-Standard-Panorama-SNMP | -| sessions | Net-PaloAlto-Standard-Sessions-SNMP | -| signatures | Net-PaloAlto-Standard-Signatures-SNMP | +| Mode | Modèle de service associé | +|:-----------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------| +| cluster-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/clusterstatus.pm)] | Net-PaloAlto-Standard-Cluster-Status-SNMP-custom | +| cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/cpu.pm)] | Net-PaloAlto-Standard-Cpu-SNMP-custom | +| gp-usage [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/gpusage.pm)] | Net-PaloAlto-Standard-Global-Protect-SNMP-custom | +| hardware [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/hardwaredevice.pm)] | Net-PaloAlto-Standard-Hardware-SNMP-custom | +| interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-PaloAlto-Standard-Interfaces-SNMP-custom | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | +| memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/memory.pm)] | Net-PaloAlto-Standard-Memory-SNMP-custom | +| panorama [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/panorama.pm)] | Net-PaloAlto-Standard-Panorama-SNMP-custom | +| sessions [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/sessions.pm)] | Net-PaloAlto-Standard-Sessions-SNMP-custom | +| signatures [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/signatures.pm)] | Net-PaloAlto-Standard-Signatures-SNMP-custom | ### Options disponibles @@ -477,61 +494,66 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --verbose | Display extended status information (long output). | -| --debug | Display debug messages. | -| --filter-perfdata | Filter perfdata that match the regexp. Eg: 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). Eg: 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). Eg: 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). Eg: 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. Eg: 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. Eg: '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 | #### Options des modes @@ -540,137 +562,157 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------| -| --threshold-overload | Set to overload default threshold value. Example: --threshold-overload='peer,critical,active' --threshold-overload='current,critical,passive' | +| Option | Description | +|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------| +| --threshold-overload | Set to overload default threshold value. Example: --threshold-overload='peer,critical,active' --threshold-overload='current,critical,passive' | -| Option | Description | -|:-------------------------|:---------------------------------------------------------------| -| --warning-* --critical-* | Thresholds. Can be: 'managementplane' (%), 'dataplane' (%). | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* --critical-* | Thresholds. Can be: 'managementplane' (%), 'dataplane' (%). | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------| -| --warning-* --critical-* | Thresholds. Can be: 'tunnels-usage', 'tunnels-usage-free', 'tunnels-usage-prct' (%). | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* --critical-* | Thresholds. Can be: 'tunnels-usage', 'tunnels-usage-free', 'tunnels-usage-prct' (%). | -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (Default: '.*'). Can be: 'device'. | -| --filter | Exclude some parts (comma seperated list) You can also exclude items from specific instances: --filter=device,network.* | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='device.network,OK,down' | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'device'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=device,network.* | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='device.network,OK,down' | +| --warning | Define the warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | +| --critical | Define the critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). package snmp\_standard::mode::components::device; use strict; use warnings; use centreon::plugins::misc; my %map\_status = (1 =\> 'unknown', 2 =\> 'running', 3 =\> 'warning', 4 =\> 'testing', 5 =\> 'down'); my %map\_type = ( '.1.3.6.1.2.1.25.3.1.1' =\> 'other', '.1.3.6.1.2.1.25.3.1.2' =\> 'unknown', '.1.3.6.1.2.1.25.3.1.3' =\> 'processor', '.1.3.6.1.2.1.25.3.1.4' =\> 'network', '.1.3.6.1.2.1.25.3.1.5' =\> 'printer', '.1.3.6.1.2.1.25.3.1.6' =\> 'diskStorage', '.1.3.6.1.2.1.25.3.1.10', =\> 'video', '.1.3.6.1.2.1.25.3.1.11' =\> 'audio', '.1.3.6.1.2.1.25.3.1.12' =\> 'coprocessor', '.1.3.6.1.2.1.25.3.1.13' =\> 'keyboard', '.1.3.6.1.2.1.25.3.1.14' =\> 'modem', '.1.3.6.1.2.1.25.3.1.15' =\> 'parallelPort', '.1.3.6.1.2.1.25.3.1.16' =\> 'pointing', '.1.3.6.1.2.1.25.3.1.17' =\> 'serialPort', '.1.3.6.1.2.1.25.3.1.18' =\> 'tape', '.1.3.6.1.2.1.25.3.1.19' =\> 'clock', '.1.3.6.1.2.1.25.3.1.20' =\> 'volatileMemory', '.1.3.6.1.2.1.25.3.1.21' =\> 'nonVolatileMemory', ); my $mapping = \{ hrDeviceType =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.2', map =\> \%map\_type \}, hrDeviceDescr =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.3' \}, hrDeviceStatus =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.5', map =\> \%map\_status \}, \}; my $oid\_hrDeviceEntry = '.1.3.6.1.2.1.25.3.2.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_hrDeviceEntry \}; \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> "Checking devices"); $self-\>\{components\}-\>\{device\} = \{name =\> 'devices', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'device')); foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_hrDeviceEntry\}\})) \{ next if ($oid !~ /^$mapping-\>\{hrDeviceStatus\}-\>\{oid\}\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_hrDeviceEntry\}, instance =\> $instance); next if ($self-\>check\_filter(section =\> 'device', instance =\> $result-\>\{hrDeviceType\} . '.' . $instance)); $result-\>\{hrDeviceDescr\} = centreon::plugins::misc::trim($result-\>\{hrDeviceDescr\}); $self-\>\{components\}-\>\{device\}-\>\{total\}++; $self-\>\{output\}-\>output\_add(long\_msg =\> sprintf("device '%s' status is '%s' \[instance = %s\]", $result-\>\{hrDeviceDescr\}, $result-\>\{hrDeviceStatus\}, $result-\>\{hrDeviceType\} . '.' . $instance)); my $exit = $self-\>get\_severity(label =\> 'default', section =\> 'device.' . $result-\>\{hrDeviceType\}, value =\> $result-\>\{hrDeviceStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add(severity =\> $exit, short\_msg =\> sprintf("Device '%s' status is '%s'", $result-\>\{hrDeviceDescr\}, $result-\>\{hrDeviceStatus\})); \} \} \} 1; | -| Option | Description | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if redis connection failed. | -| --memexpiration | Time to keep data in seconds (Default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (Default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (Default: 'AES'). | -| --add-global | Check global port statistics (By default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (Default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (Default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (Default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (Default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) ex: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src | Regexp src to transform display value. | -| --display-transform-dst | Regexp dst to transform display value. | -| --show-cache | Display cache interface datas. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if redis connection failed. | -| --memexpiration | Time to keep data in seconds (Default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (Default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (Default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --units | Units of thresholds (Default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage (number expected) ex: 1, 2,... (empty means 'check all storage'). | -| --name | Allows to use storage name with option --storage instead ofstorage oid index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-isensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --show-cache | Display cache storage datas. | -| --filter-storage-type | Filter storage types with a regexp (Default: '^(hrStorageRam\|hrStorageFlashMemory)$'). | +| Option | Description | +|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageRam\|hrStorageFlashMemory)$'). | -| Option | Description | -|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --warning-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{status\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{status\} =~ /not-connected/i'). You can use the following variables: %\{status\}, %\{display\} | +| Option | Description | +|:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /not-connected/i'). You can use the following variables: %\{status\}, %\{display\} | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --add-vsys | Monitor virtual systems. | -| --filter-vsys-name | Filter virtual systems by name (can be a regexp). | -| --warning-* --critical-* | Thresholds. Global: 'active', 'active-prct', (%), 'active-tcp', 'active-udp', 'active-icmp', Per vsys: 'vsys-active', 'vsys-active-prct' (%), 'vsys-active-tcp' 'vsys-active-udp' 'vsys-active-other'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --add-vsys | Monitor virtual systems. | +| --filter-vsys-name | Filter virtual systems by name (can be a regexp). | +| --warning-* --critical-* | Thresholds. Global: 'active', 'active-prct', (%), 'active-tcp', 'active-udp', 'active-icmp', Per vsys: 'vsys-active', 'vsys-active-prct' (%), 'vsys-active-tcp' 'vsys-active-udp' 'vsys-active-other'. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='av-update' | -| --timezone | Timezone options. Default is 'GMT'. | -| --warning-* --critical-* | Thresholds. Can be: 'av-update' (s), 'threat-update' (s), 'wildfire-update' (s). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='av-update' | +| --timezone | Timezone options. Default is 'GMT'. | +| --warning-* --critical-* | Thresholds. Can be: 'av-update' (s), 'threat-update' (s), 'wildfire-update' (s). | @@ -679,8 +721,8 @@ Pour un mode, la liste de toutes les options disponibles et leur signification p affichée en ajoutant le paramètre `--help` à la commande : ```bash -/usr/lib/centreon/plugins//centreon_paloalto.pl \ +/usr/lib/centreon/plugins/centreon_paloalto.pl \ --plugin=network::paloalto::snmp::plugin \ - --mode=cluster-status \ + --mode=panorama \ --help ``` diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-ssh.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-ssh.md index f14d95c9541a..77c7342e1aa7 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-ssh.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-ssh.md @@ -40,12 +40,21 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -Coming soon +| Nom | Unité | +|:-----------------------------|:------| +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | +| hardware.voltage.status | N/A | +| hardware.voltage.count | count | +| hardware.voltage.volt | V | -| Métrique | Unité | +| Nom | Unité | |:----------------------------|:------| | sync-status | N/A | | *member*~member-status | N/A | @@ -54,7 +63,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:-----------------------|:------| | interfaces.total.count | count | | *interface*#status | N/A | @@ -62,7 +71,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:--------------------------|:------| | tunnels.ipsec.total.count | count | | *tunnels*#status | N/A | @@ -70,7 +79,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:------------------|:------| | *features*#status | N/A | @@ -79,7 +88,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------|:------| | status | N/A | | system.antivirus.lastupdate.time.seconds | s | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md index 26421b860888..a71e1318b29c 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md @@ -1,15 +1,21 @@ --- id: network-firewalls-stonesoft -title: Stonesoft +title: Stonesoft 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 **Stonesoft SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles -Le connecteur de supervision **Stonesoft** apporte un modèle d'hôte : +Le connecteur de supervision **Stonesoft SNMP** apporte un modèle d'hôte : * **Net-Stonesoft-SNMP-custom** @@ -36,11 +42,11 @@ Le connecteur apporte les modèles de service suivants |:---------------------|:-----------------------------------------------|:-----------------------------------------------|:----------:| | Cluster-Load | Net-Stonesoft-Cluster-Load-SNMP-custom | Contrôle de la charge consommée par le cluster | | | Cluster-State | Net-Stonesoft-Cluster-State-SNMP-custom | Contrôle l'état du cluster | | -| Disk-Global | Net-Stonesoft-Disk-Global-SNMP-custom | Contrôle du taux d'utilisation des disques | | -| Disk-Name | Net-Stonesoft-Disk-Name-SNMP-custom | Contrôle du taux d'utilisation des disques | | +| Disk-Global | Net-Stonesoft-Disk-Global-SNMP-custom | Contrôle du taux d'utilization des disques | | +| Disk-Name | Net-Stonesoft-Disk-Name-SNMP-custom | Contrôle du taux d'utilization des disques | | | Traffic-Generic-ID | Net-Stonesoft-Traffic-Generic-ID-SNMP-custom | Contrôle de la bande passante de l'interface | | | Traffic-Generic-Name | Net-Stonesoft-Traffic-Generic-Name-SNMP-custom | Contrôle de la bande passante de l'interface | | -| Traffic-Global | Net-Stonesoft-Traffic-Global-SNMP-custom | Contrôle de la bande passante de l'interface | X | +| Traffic-Global | Net-Stonesoft-Traffic-Global-SNMP-custom | Contrôle de la bande passante de l'interface | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -51,39 +57,39 @@ Le connecteur apporte les modèles de service suivants ### Règles de découverte -#### Découverte de service +#### Découverte de services -| Nom de la règle | Description | -|:--------------------------------|:--------------------------------------------------------------| -| Net-StoneSoft-SNMP-Traffic-Name | Discover network interfaces and monitor bandwidth utilization | +| Nom de la règle | Description | +|:--------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-StoneSoft-SNMP-Traffic-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | -|:------------|:------| -| cpuload | % | +| Nom | Unité | +|:--------|:------| +| cpuload | % | -| Métrique | Unité | -|:------------|:------| -| status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. -| Métrique | Unité | +| Nom | Unité | |:----------------------------|:------| | connections.total.count | con | | connections.total.persecond | con/s | @@ -93,59 +99,65 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:--------------|:------| | total_cpu_avg | % | -Coming soon +| Nom | Unité | +|:-----|:------| +| free | B | +| used | B | -Coming soon +| Nom | Unité | +|:-----|:------| +| free | B | +| used | B | -| Métrique | Unité | +| Nom | Unité | |:------------------------|:------| | dropped_packets_per_sec | N/A | -| Métrique | Unité | -|:------------|:------| -| cached | B | -| buffer | B | -| used | B | -| swap | B | +| Nom | Unité | +|:-------|:------| +| cached | B | +| buffer | B | +| used | B | +| swap | B | -| Métrique | Unité | +| Nom | Unité | |:-------------------------|:------| | rejected_packets_per_sec | N/A | -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | @@ -158,7 +170,10 @@ Coming soon ### 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 @@ -168,10 +183,8 @@ La communication doit être possible sur le port UDP 161 depuis le collecteur Ce ### 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 : @@ -207,8 +220,8 @@ yum install centreon-pack-network-firewalls-stonesoft -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Stonesoft** -depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Stonesoft SNMP** +depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision**. ### Plugin @@ -261,8 +274,8 @@ yum install centreon-plugin-Network-Firewalls-Stonesoft 3. Appliquez le modèle d'hôte **Net-Stonesoft-SNMP-custom**. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur. 4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires. -| 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). | | | 5. [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. @@ -275,120 +288,120 @@ yum install centreon-plugin-Network-Firewalls-Stonesoft -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | | | | -| CRITICAL | | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| CRITICALCONNECTIONS | Critical threshold | | | -| WARNINGCONNECTIONS | Warning threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CRITICALCONNECTIONS | Threshold | | | +| WARNINGCONNECTIONS | 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 | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| CRITICAL | Critical threshold in percent | 90 | | -| WARNING | Warning threshold in percent | 80 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CRITICAL | Critical threshold in percent | 90 | | +| WARNING | Warning threshold in percent | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the storage name (empty means 'check all storage') | ^(?!(/)$) | | -| CRITICAL | Critical threshold | 90 | | -| WARNING | Warning threshold | 80 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Set the storage name (empty means 'check all storage') | ^(?!(/)$) | | +| CRITICAL | Critical threshold | 90 | | +| WARNING | Warning threshold | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| DISKNAME | Set the storage name (empty means 'check all storage') | | | -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| DISKNAME | Set the storage name (empty means 'check all storage') | | | +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold for dropped packets per second | | | -| CRITICAL | Critical threshold for dropped packets per second | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold for dropped packets per second | | | +| CRITICAL | Critical threshold for dropped packets per second | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent | 80 | | -| CRITICAL | Critical threshold in percent. -swap Check swap also | 90 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent | 80 | | +| CRITICAL | Critical threshold in percent | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold for blocked packets per second | | | -| CRITICAL | Critical threshold for blocked packets per second | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold for blocked packets per second | | | +| CRITICAL | Critical threshold for blocked packets per second | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGIN | Thresholds | | | -| CRITICALIN | Thresholds | | | -| WARNINGOUT | Thresholds | | | -| CRITICALOUT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Threshold | | | +| CRITICALIN | Threshold | | | +| WARNINGOUT | Threshold | | | +| CRITICALOUT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGIN | Thresholds | | | -| CRITICALIN | Thresholds | | | -| WARNINGOUT | Thresholds | | | -| CRITICALOUT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Threshold | | | +| CRITICALIN | Threshold | | | +| WARNINGOUT | Threshold | | | +| CRITICALOUT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | .* | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -470,281 +483,275 @@ 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 an "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %\{variable\} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. | -| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '\_max' suffix). Example: it will split 'used\_prct'=26.93%;0:80;0:90;0;100 into 'used\_prct'=26.93%;0:80;0:90;0;100 'used\_prct\_max'=100%;;;; | -| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[m ax\]\] Common examples: Convert storage free perfdata into used: --change-perfdata=free,used,invert() Convert storage free perfdata into used: --change-perfdata=used,free,invert() Scale traffic values automatically: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic\_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic\_in,,percent() | -| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard \|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | -| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | -| --filter-uom | Mask the units when they don't match the given regular expression. | -| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | -| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | -| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | -| --output-xml | Return the output in XML format (to send to an XML API). | -| --output-json | Return the output in JSON format (to send to a JSON API). | -| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | -| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | -| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | -| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | -| --float-precision | Define the float precision for thresholds (default: 8). | -| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. | -| --hostname | Name or address of the host to monitor (mandatory). | -| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | -| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | -| --snmp-port | UDP port to send the SNMP request to (default: 161). | -| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | -| --snmp-retries | Maximum number of retries (default: 5). | -| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | -| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | -| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | -| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | -| --snmp-cache-file | Use SNMP cache file. | -| --snmp-username | SNMP v3 only: User name (securityName). | -| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | -| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | -| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | -| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | -| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | -| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | -| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | -| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | -| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | -| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | -| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | -| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | +| Option | Description | +|:-------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). | +| --dyn-mode | Specify a mode with the module's path (advanced). | +| --list-mode | List all available modes. | +| --mode-version | Check minimal version of mode. If not, unknown error. | +| --version | Return the version of the plugin. | +| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | +| --hostname | Name or address of the host to monitor (mandatory). | +| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | +| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | +| --snmp-port | UDP port to send the SNMP request to (default: 161). | +| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | +| --snmp-retries | Maximum number of retries (default: 5). | +| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | +| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | +| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | +| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | +| --snmp-cache-file | Use SNMP cache file. | +| --snmp-username | SNMP v3 only: User name (securityName). | +| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | +| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | +| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | +| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | +| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | +| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | +| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | +| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | +| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | +| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | +| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | +| --verbose | Display extended status information (long output). | +| --debug | Display debug messages. | +| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | +| --filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %\{variable\} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. | +| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '\_max' suffix. Example: it will split 'used\_prct'=26.93%;0:80;0:90;0;100 into 'used\_prct'=26.93%;0:80;0:90;0;100 'used\_prct\_max'=100%;;;; | +| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated \ (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard\|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traffic\_(in\|out)\_$1)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --change-output-adv | Replace short output and exit code based on a "if" condition using the following variables: short\_output, exit\_code. Variables must be written either %\{variable\} or %(variable). Example: adding --change-output-adv='%(short\_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | #### Options des modes Les options disponibles pour chaque modèle de services sont listées ci-dessous : - - -| Option | Description | -|:-------|:------------| - - -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{node_status\} =~ /unknown/i'). You can use the following variables: %\{node_status\}, %\{node_member_id\}. | -| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{node_status\} =~ /lockedOnline/i'). You can use the following variables: %\{node_status\}, %\{node_member_id\}. | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{node_status\} =~ /^(?:offline\|goingOffline\|lockedOffline\|goingLockedOffline\|stand by\|goingStandby)$/i'). You can use the following variables: %\{node_status\}, %\{node_member_id\}. | +| Option | Description | +|:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{node\_status\} =~ /unknown/i'). You can use the following variables: %\{node\_status\}, %\{node\_member\_id\}. | +| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{node\_status\} =~ /lockedOnline/i'). You can use the following variables: %\{node\_status\}, %\{node\_member\_id\}. | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{node\_status\} =~ /^(?:offline\|goingOffline\|lockedOffline\|goingLockedOffline\|standby\|goingStandby)$/i'). You can use the following variables: %\{node\_status\}, %\{node\_member\_id\}. | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-* | Warning threshold. Can be: 'connections', 'rate-connections'. | -| --critical-* | Critical threshold. Can be: 'connections', 'rate-connections'. | +| Option | Description | +|:------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* | Warning threshold. Can be: 'connections', 'rate-connections'. | +| --critical-* | Critical threshold. Can be: 'connections', 'rate-connections'. | -| Option | Description | -|:-----------|:----------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. | +| Option | Description | +|:-----------|:------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | -| Option | Description | -|:---------------------|:------------------------------------------------------------| -| --warning | Warning threshold. | -| --critical | Critical threshold. | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage name (empty means 'check all storage'). | -| --regexp | Allows to use regexp to filter storage. | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| Option | Description | +|:---------------------|:--------------------------------------------------------------| +| --warning | Warning threshold. | +| --critical | Critical threshold. | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage name (empty means 'check all storage'). | +| --regexp | Allows to use regexp to filter storage. | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| Option | Description | -|:---------------------|:------------------------------------------------------------| -| --warning | Warning threshold. | -| --critical | Critical threshold. | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage name (empty means 'check all storage'). | -| --regexp | Allows to use regexp to filter storage. | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| Option | Description | +|:---------------------|:--------------------------------------------------------------| +| --warning | Warning threshold. | +| --critical | Critical threshold. | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage name (empty means 'check all storage'). | +| --regexp | Allows to use regexp to filter storage. | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning | Warning threshold for dropped packets per second. | -| --critical | Critical threshold for dropped packets per second. | +| Option | Description | +|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning | Warning threshold for dropped packets per second. | +| --critical | Critical threshold for dropped packets per second. | -| Option | Description | -|:----------------|:---------------------------------------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. -swap Check swap also. | -| --warning-swap | Warning threshold in percent. | -| --critical-swap | Critical threshold in percent. | -| --no-swap | Threshold if no active swap (default: 'critical'). | +| Option | Description | +|:----------------|:--------------------------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | +| --swap | Check swap also. | +| --warning-swap | Warning threshold in percent. | +| --critical-swap | Critical threshold in percent. | +| --no-swap | Threshold if no active swap (default: 'critical'). | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning | Warning threshold for blocked packets per second. | -| --critical | Critical threshold for blocked packets per second. | +| Option | Description | +|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning | Warning threshold for blocked packets per second. | +| --critical | Critical threshold for blocked packets per second. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface datas. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface datas. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-hp-vc-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-hp-vc-snmp.md index d10f766de588..b622be70abaf 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-hp-vc-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-hp-vc-snmp.md @@ -67,12 +67,32 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -Coming soon +| Nom | Unité | +|:--------------------------------------|:------| +| hardware.domain.status | N/A | +| hardware.domain.count | count | +| hardware.enclosure.status | N/A | +| hardware.enclosure.count | count | +| hardware.enet.status | N/A | +| hardware.enet.count | count | +| hardware.fc.status | N/A | +| hardware.fc.count | count | +| hardware.module.status | N/A | +| hardware.module.count | count | +| hardware.moduleport.loop.status | N/A | +| hardware.moduleport.protection.status | N/A | +| hardware.moduleport.count | count | +| hardware.physicalserver.status | N/A | +| hardware.physicalserver.count | count | +| hardware.port.status | N/A | +| hardware.port.count | count | +| hardware.profile.status | N/A | +| hardware.profile.count | count | -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------------------|:------| | *interface_name*#status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-alcatel-omniswitch-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-alcatel-omniswitch-snmp.md index 1077e6af684d..c48cdd242899 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-alcatel-omniswitch-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-switchs-alcatel-omniswitch-snmp.md @@ -5,6 +5,12 @@ title: Alcatel Omniswitch 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 **Alcatel Omniswitch** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles @@ -33,7 +39,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | Découverte | |:----------------|:---------------------------------------------------|:----------------------------------------------------|:----------:| -| Interfaces | Net-Alcatel-Omniswitch-Interfaces-SNMP-custom | Contrôle les interfaces | X | +| Interfaces | Net-Alcatel-Omniswitch-Interfaces-SNMP-custom | Contrôle les interfaces | X | | Spanning-Tree | Net-Alcatel-Omniswitch-SpanningTree-SNMP-custom | Contrôle l'état du spanning tree sur les interfaces | | | Virtual-Chassis | Net-Alcatel-Omniswitch-Virtual-Chassis-SNMP-custom | Contrôle l'état des chassis virtuels | | @@ -48,34 +54,37 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Nom de la règle | Description | +|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Alcatel-OmniSwitch-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 service +#### Découverte de services -| Nom de la règle | Description | -|:-------------------------------------------|:--------------------------------------------------------------| -| Net-Alcatel-Omniswitch-SNMP-Interface-Name | Discover network interfaces and monitor bandwidth utilization | +| Nom de la règle | Description | +|:-------------------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-Alcatel-Omniswitch-SNMP-Interface-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -Coming soon +| Nom | Unité | +|:------|:------| +| cpu1m | % | +| cpu1h | % | -| Métrique | Unité | +| Nom | Unité | |:---------------------------|:------| | *memory*#flash.usage.bytes | B | @@ -84,14 +93,45 @@ Coming soon -Coming soon +| Nom | Unité | +|:--------------------------------|:------| +| hardware.backplane.status | N/A | +| hardware.backplane.count | count | +| hardware.backplane.power.watt | W | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | +| hardware.container.status | N/A | +| hardware.container.count | count | +| hardware.container.power.watt | W | +| hardware.fan.status | N/A | +| hardware.fan.count | count | +| hardware.fan.power.watt | W | +| hardware.module.status | N/A | +| hardware.module.count | count | +| hardware.module.power.watt | W | +| hardware.other.status | N/A | +| hardware.other.count | count | +| hardware.other.power.watt | W | +| hardware.port.status | N/A | +| hardware.port.count | count | +| hardware.port.power.watt | W | +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.powersupply.power.watt | W | +| hardware.sensor.status | N/A | +| hardware.sensor.count | count | +| hardware.sensor.power.watt | W | +| hardware.stack.status | N/A | +| hardware.stack.count | count | +| hardware.stack.power.watt | W | -| Métrique | Unité | +| Nom | Unité | |:----------------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | | *interface_name*#interface.packets.in.discard.percentage | % | @@ -102,24 +142,28 @@ Coming soon -Coming soon +| Nom | Unité | +|:------|:------| +| mem1m | % | +| mem1h | % | -| Métrique | Unité | -|:-----------------------|:------| -| *spanningtrees*#status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. -| Métrique | Unité | -|:-------------------------|:------| -| chassis.detected.count | count | -| *chassis*#chassis-status | N/A | +| Nom | Unité | +|:-----------------------|:------| +| chassis.detected.count | count | +| chassis-status | N/A | +| chassis-status | N/A | @@ -142,10 +186,8 @@ Centreon vers le serveur supervisé. ### 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 : @@ -182,7 +224,7 @@ yum install centreon-pack-network-switchs-alcatel-omniswitch-snmp 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Alcatel Omniswitch** -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 @@ -235,11 +277,11 @@ yum install centreon-plugin-Network-Switchs-Alcatel-Omniswitch-Snmp 3. Appliquez le modèle d'hôte **Net-Alcatel-OmniSwitch-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 | -|:-----------------|:----------------------------------------------------------------------------------------------|:------------------|:-----------:| -| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (e.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | +| 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. @@ -251,81 +293,81 @@ yum install centreon-plugin-Network-Switchs-Alcatel-Omniswitch-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:--------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent (1m,1h) | | | -| CRITICAL | Critical threshold in percent (1m,1h) | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent (1m,1h) | | | +| CRITICAL | Critical threshold in percent (1m,1h) | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:--------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent | | | -| CRITICAL | Critical threshold in percent | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent | | | +| CRITICAL | Critical threshold in percent | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:--------------------------------------------------------------------------------------------|:------------------|:-----------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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 | -|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| -| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGINDISCARD | Thresholds | | | -| CRITICALINDISCARD | Thresholds | | | -| WARNINGINERROR | Thresholds | | | -| CRITICALINERROR | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGOUTDISCARD | Thresholds | | | -| CRITICALOUTDISCARD | Thresholds | | | -| WARNINGOUTERROR | Thresholds | | | -| CRITICALOUTERROR | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| +| OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINDISCARD | Threshold | | | +| CRITICALINDISCARD | Threshold | | | +| WARNINGINERROR | Threshold | | | +| CRITICALINERROR | Threshold | | | +| WARNINGINTRAFFIC | Threshold | | | +| CRITICALINTRAFFIC | Threshold | | | +| WARNINGOUTDISCARD | Threshold | | | +| CRITICALOUTDISCARD | Threshold | | | +| WARNINGOUTERROR | Threshold | | | +| CRITICALOUTERROR | Threshold | | | +| WARNINGOUTTRAFFIC | Threshold | | | +| CRITICALOUTTRAFFIC | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:--------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent (1m,1h) | | | -| CRITICAL | Critical threshold in percent (1m,1h) | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent (1m,1h) | | | +| CRITICAL | Critical threshold in percent (1m,1h) | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| -| FILTERPORT | Filter on port description (can be a regexp) | .* | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{op_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op_status\}, %\{admin_status\}, %\{port\}, %\{index\} | %\{state\} =~ /blocking\|broken/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op_status\}, %\{admin_status\}, %\{port\}, %\{index\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------|:-----------:| +| FILTERPORT | Filter on port description (can be a regexp) | .* | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\} | %\{state\} =~ /blocking\|broken/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\} | | | +| 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 | -|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| -| WARNINGCHASSISDETECTED | Thresholds | | | -| CRITICALCHASSISDETECTED | Thresholds | | | -| CRITICALCHASSISSTATUS | Define the conditions to match for the status to be CRITICAL (default: %\{status\} !~ /init\|running/) You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | %\{status\} !~ /init\|running/ | | -| WARNINGCHASSISSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). Toutes les options sont listées [ici](#options-disponibles) | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| +| WARNINGCHASSISDETECTED | Threshold | | | +| CRITICALCHASSISDETECTED | Threshold | | | +| CRITICALCHASSISSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | %\{status\} !~ /init\|running/ | | +| WARNINGCHASSISSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | | | +| 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 | | @@ -343,38 +385,21 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : ```bash /usr/lib/centreon/plugins/centreon_alcatel_omniswitch_snmp.pl \ --plugin=network::alcatel::omniswitch::snmp::plugin \ - --mode=interfaces \ + --mode=virtual-chassis \ --hostname='10.0.0.1' \ --snmp-version='2c' \ --snmp-community='my-snmp-community' \ - --interface='' \ - --name \ - --add-status \ - --add-traffic \ - --add-errors \ - --warning-status='' \ - --critical-status='%\{admstatus\} eq "up" and %\{opstatus\} !~ /up|dormant/' \ - --warning-in-traffic='' \ - --critical-in-traffic='' \ - --warning-out-traffic='' \ - --critical-out-traffic='' \ - --warning-in-discard='' \ - --critical-in-discard='' \ - --warning-out-discard='' \ - --critical-out-discard='' \ - --warning-in-error='' \ - --critical-in-error='' \ - --warning-out-error='' \ - --critical-out-error='' \ - --oid-filter='ifname' \ - --oid-display='ifname' \ + --warning-chassis-status='' \ + --critical-chassis-status='%\{status\} !~ /init|running/' \ + --warning-chassis-detected='' \ + --critical-chassis-detected='' \ --verbose ``` La commande devrait retourner un message de sortie similaire à : ```bash -OK: All interfaces are ok | '*interface_name*#status'='up';;;;'*interface_name*#interface.traffic.in.bitspersecond'=20b/s;;;;'*interface_name*#interface.traffic.out.bitspersecond'=20b/s;;;; +OK: detected chassis: 8 All virtual chassis are ok | 'chassis.detected.count'=8;;;0; ``` ### Diagnostic des erreurs communes @@ -418,61 +443,66 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --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 | #### Options des modes @@ -481,103 +511,108 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-----------|:------------------------------------------| -| --warning | Warning threshold in percent (1m,1h). | -| --critical | Critical threshold in percent (1m,1h). | +| Option | Description | +|:-----------|:-------------------------------------------------| +| --warning | Warning threshold in percent (1m,1h). | +| --critical | Critical threshold in percent (1m,1h). | -| Option | Description | -|:-----------------|:----------------------------------| -| --warning-usage | Warning threshold in percent. | -| --critical-usage | Critical threshold in percent. | +| Option | Description | +|:------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-usage | Warning threshold in percent. | +| --critical-usage | Critical threshold in percent. | -| Option | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'other', 'unknown', 'chassis', 'backplane', 'container', 'psu', 'fan', 'sensor', 'module', 'port, 'stack'. Some not exists ;) | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan). You can also exclude items from specific instances: --filter=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu.oper,CRITICAL,standby' | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'other', 'unknown', 'chassis', 'backplane', 'container', 'psu', 'fan', 'sensor', 'module', 'port, 'stack'. Some not exists ;) | +| --filter | Exclude the items given as a comma-separated list (example: --filter=fan). You can also exclude items from specific instances: --filter=fan,1.2 | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu.oper,CRITICAL,standby' | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface datas. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | -| Option | Description | -|:-----------|:------------------------------------------| -| --warning | Warning threshold in percent (1m,1h). | -| --critical | Critical threshold in percent (1m,1h). | +| Option | Description | +|:-----------|:--------------------------------------------| +| --warning | Warning threshold in percent (1m,1h). | +| --critical | Critical threshold in percent (1m,1h). | -| Option | Description | -|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-port | Filter on port description (can be a regexp). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op_status\}, %\{admin_status\}, %\{port\}, %\{index\}. | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op_status\}, %\{admin_status\}, %\{port\}, %\{index\}. | +| Option | Description | +|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --filter-port | Filter on port description (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op\_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | -| Option | Description | -|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --unknown-chassis-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | -| --warning-chassis-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | -| --critical-chassis-status | Define the conditions to match for the status to be CRITICAL (default: %\{status\} !~ /init\|running/) You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | -| --warning-* --critical-* | Thresholds. Can be: 'chassis-detected'. | +| Option | Description | +|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --unknown-chassis-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | +| --warning-chassis-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | +| --critical-chassis-status | Define the conditions to match for the status to be CRITICAL (default: %\{status\} !~ /init\|running/) You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | +| --warning-* --critical-* | Thresholds. Can be: 'chassis-detected'. | @@ -588,6 +623,6 @@ affichée en ajoutant le paramètre `--help` à la commande : ```bash /usr/lib/centreon/plugins/centreon_alcatel_omniswitch_snmp.pl \ --plugin=network::alcatel::omniswitch::snmp::plugin \ - --mode=interfaces \ + --mode=virtual-chassis \ --help ``` diff --git a/pp/integrations/plugin-packs/procedures/applications-mscs-nrpe.md b/pp/integrations/plugin-packs/procedures/applications-mscs-nrpe.md index d7cf78313e60..84de04346cf6 100644 --- a/pp/integrations/plugin-packs/procedures/applications-mscs-nrpe.md +++ b/pp/integrations/plugin-packs/procedures/applications-mscs-nrpe.md @@ -17,9 +17,40 @@ agent to check the health and performance of Microsoft Clusters. * Microsoft Server with the MSCS extension -### Collected metrics +### Collected metrics & status -*Coming soon* +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. + + + + +| Name | Unit | +|:-------|:------| +| status | N/A | + + + + +| Name | Unit | +|:-------|:------| +| status | N/A | + + + + +| Name | Unit | +|:-------|:------| +| status | N/A | + + + + +| Name | Unit | +|:-------|:------| +| status | N/A | + + + ## Prerequisites diff --git a/pp/integrations/plugin-packs/procedures/cloud-azure-compute-virtualmachine.md b/pp/integrations/plugin-packs/procedures/cloud-azure-compute-virtualmachine.md index c41c038ac039..a45c270563e6 100644 --- a/pp/integrations/plugin-packs/procedures/cloud-azure-compute-virtualmachine.md +++ b/pp/integrations/plugin-packs/procedures/cloud-azure-compute-virtualmachine.md @@ -117,7 +117,14 @@ Here is the list of services for this connector, detailing all metrics and statu -Coming soon +| Name | Unit | +|:----------------------------------|:-----| +| azvm.general.standard_B* | N/A | +| azvm.compute.standard_F* | N/A | +| azvm.memory.standard_E* | N/A | +| azvm.storage.standard_L* | N/A | +| azvm.gpu.standard_N* | N/A | +| azvm.high_performance.standard_H* | N/A | diff --git a/pp/integrations/plugin-packs/procedures/hardware-storage-avid-isis-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-storage-avid-isis-snmp.md index 57afea8ad645..7363d18b5a21 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-storage-avid-isis-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-storage-avid-isis-snmp.md @@ -47,15 +47,33 @@ Here is the list of services for this connector, detailing all metrics linked to -Coming soon +| Name | Unit | +|:-----------------------------|:------| +| hardware.alarm.status | N/A | +| hardware.alarm.count | count | +| hardware.fan.status | N/A | +| hardware.fan.count | count | +| hardware.pdrive.status | N/A | +| hardware.pdrive.count | count | +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.sim.status | N/A | +| hardware.sim.count | count | +| hardware.slot.status | N/A | +| hardware.slot.count | count | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | +| hardware.vdrive.status | N/A | +| hardware.vdrive.count | count | -| Metric name | Unit | +| Name | Unit | |:-----------------|:-----------| -| active_clients | clients | -| open-files | files | +| active_clients | count | +| open-files | count | | processing-speed | messages/s | | read-throughput | B/s | | write-throughput | B/s | @@ -65,7 +83,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:---------------------|:------| | status | N/A | | redistributing-count | N/A | @@ -75,7 +93,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:----------------|:------| | allocated | B | | workspace-count | N/A | diff --git a/pp/integrations/plugin-packs/procedures/network-3com-snmp.md b/pp/integrations/plugin-packs/procedures/network-3com-snmp.md index 57e56a3f5e37..38418faa28c0 100644 --- a/pp/integrations/plugin-packs/procedures/network-3com-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-3com-snmp.md @@ -69,36 +69,41 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | -|:------------------------------------|:------| -| *cpu*#cpu.utilization.5s.percentage | % | -| *cpu*#cpu.utilization.1m.percentage | % | -| *cpu*#cpu.utilization.5m.percentage | % | +| Name | Unit | +|:------------------------------------|:-----| +| *cpu*#cpu.utilization.5s.percentage | % | +| *cpu*#cpu.utilization.1m.percentage | % | +| *cpu*#cpu.utilization.5m.percentage | % | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -Coming soon +| Name | Unit | +|:--------------------|:------| +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.fan.status | N/A | +| hardware.fan.count | count | -| Metric name | Unit | -|:----------------------------|:------| -| *memory*#memory.usage.bytes | B | +| Name | Unit | +|:----------------------------|:-----| +| *memory*#memory.usage.bytes | B | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | +| Name | Unit | +|:-----------------------------------------------------|:-----| +| *interface_name*#status | N/A | +| *interface_name*#interface.traffic.in.bitspersecond | b/s | +| *interface_name*#interface.traffic.out.bitspersecond | b/s | > Applies to the following service templates: Traffic-Generic-Id, Traffic-Generic-Name, Traffic-Global diff --git a/pp/integrations/plugin-packs/procedures/network-dlink-standard-snmp.md b/pp/integrations/plugin-packs/procedures/network-dlink-standard-snmp.md index b256ac74b9b9..c4f211c28726 100644 --- a/pp/integrations/plugin-packs/procedures/network-dlink-standard-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-dlink-standard-snmp.md @@ -67,7 +67,7 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | +| Name | Unit | |:----------------------------------------------|:------| | cpu.utilization.5s.percentage | % | | cpu.utilization.1m.percentage | % | @@ -79,12 +79,21 @@ Here is the list of services for this connector, detailing all metrics linked to -Coming soon +| Name | Unit | +|:-----------------------------|:------| +| hardware.fan.status | N/A | +| hardware.fan.count | count | +| hardware.fan.speed.rpm | rpm | +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | -| Metric name | Unit | +| Name | Unit | |:----------------------------------------------------------|:------| | *interface_name*#status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | @@ -97,7 +106,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:---------------------------------|:------| | *memory*#memory.usage.bytes | B | | *memory*#memory.free.bytes | B | @@ -106,7 +115,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:----------------------------|:------| | stack.members.total.count | count | | *member*~member-status | N/A | diff --git a/pp/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md b/pp/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md index bab4763741a3..29181b558cfa 100644 --- a/pp/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md @@ -5,6 +5,12 @@ title: Palo Alto firewall SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Palo Alto firewall SNMP** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates @@ -47,6 +53,14 @@ The connector brings the following service templates (sorted by the host templat ### Discovery rules +#### Host discovery + +| Rule name | Description | +|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-PaloAlto-Standard-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 | @@ -58,20 +72,21 @@ and in the [following chapter](/docs/monitoring/discovery/services-discovery/#di ### 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 | |:-------------------------|:------| -| cluster status | | -| high-availability status | | +| cluster status | N/A | +| high-availability status | N/A | + -| Metric name | Unit | +| Name | Unit | |:-------------------------------------------|:------| | cpu.managementplane.utilization.percentage | % | | cpu.dataplane.utilization.percentage | % | @@ -79,7 +94,7 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | +| Name | Unit | |:---------------------------------------|:------| | globalprotect.tunnels.usage.count | count | | globalprotect.tunnels.free.count | count | @@ -88,57 +103,61 @@ Here is the list of services for this connector, detailing all metrics linked to -Coming soon +| Name | Unit | +|:-----------------------|:------| +| hardware.device.status | N/A | +| hardware.device.count | count | -| Metric name | Unit | +| Name | Unit | |:----------------------------------------------------------|:------| -| interface status | | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | -| *interface_name*#interface.packets.in.error.percentage | % | | *interface_name*#interface.packets.in.discard.percentage | % | -| *interface_name*#interface.packets.out.error.percentage | % | +| *interface_name*#interface.packets.in.error.percentage | % | | *interface_name*#interface.packets.out.discard.percentage | % | +| *interface_name*#interface.packets.out.error.percentage | % | -| Metric name | Unit | +| Name | Unit | |:---------------------------------|:------| | *name*#storage.space.usage.bytes | B | -> To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. - -| Metric name | Unit | -|:----------------|:------| -| panorama status | N/A | +| Name | Unit | +|:-------|:------| +| status | N/A | +| status | N/A | + +> To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:--------------------------------------|:------| -| sessions.active.count | count | -| sessions.active.percentage | % | -| sessions.active.tcp.count | count | -| sessions.active.udp.count | count | -| sessions.active.icmp.count | count | -| vsys#vsys.sessions.active.count | count | -| vsys#vsys.sessions.active.percentage | % | -| vsys#vsys.sessions.active.tcp.count | count | -| vsys#vsys.sessions.active.udp.count | count | -| vsys#vsys.sessions.active.other.count | count | +| Name | Unit | +|:----------------------------------------|:------| +| sessions.active.count | count | +| sessions.active.percentage | % | +| sessions.active.tcp.count | count | +| sessions.active.udp.count | count | +| sessions.active.icmp.count | count | +| *vsys*#vsys.sessions.active.count | count | +| *vsys*#vsys.sessions.active.percentage | % | +| *vsys*#vsys.sessions.active.tcp.count | count | +| *vsys*#vsys.sessions.active.udp.count | count | +| *vsys*#vsys.sessions.active.other.count | count | -| Metric name | Unit | +| Name | Unit | |:--------------------------------------------|:------| | signature.antivirus.lastupdate.time.seconds | s | | signature.threat.lastupdate.time.seconds | s | @@ -151,7 +170,10 @@ Coming soon ### SNMP Configuration -To use this Pack, the SNMP service must be properly configured on your device. +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 @@ -162,12 +184,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: @@ -203,7 +222,7 @@ yum install centreon-pack-network-firewalls-paloalto-standard-snmp 2. Whatever the license type (*online* or *offline*), install the **Palo Alto firewall SNMP** connector through -the **Configuration > Connectors > Monitoring Connectors** menu. +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -254,15 +273,15 @@ yum install centreon-plugin-Network-Firewalls-Paloalto-Standard-Snmp ### Using a host template provided by the connector 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-PaloAlto-Standard-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 (E.g. a --verbose flag). 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. @@ -274,150 +293,149 @@ yum install centreon-plugin-Network-Firewalls-Paloalto-Standard-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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 | -|:------------------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | | 80 | | -| CRITICAL | | 90 | | -| WARNINGDATAPLANE | Thresholds | | | -| CRITICALDATAPLANE | Thresholds | | | -| WARNINGMANAGEMENTPLANE | Thresholds | | | -| CRITICALMANAGEMENTPLANE | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGDATAPLANE | Threshold | | | +| CRITICALDATAPLANE | Threshold | | | +| WARNINGMANAGEMENTPLANE | Threshold | | | +| CRITICALMANAGEMENTPLANE | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGTUNNELSUSAGE | Thresholds | | | -| CRITICALTUNNELSUSAGE | Thresholds | | | -| WARNINGTUNNELSUSAGEFREE | Thresholds | | | -| CRITICALTUNNELSUSAGEFREE | Thresholds | | | -| WARNINGTUNNELSUSAGEPRCT | Thresholds | | | -| CRITICALTUNNELSUSAGEPRCT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGTUNNELSUSAGE | Threshold | | | +| CRITICALTUNNELSUSAGE | Threshold | | | +| WARNINGTUNNELSUSAGEFREE | Threshold | | | +| CRITICALTUNNELSUSAGEFREE | Threshold | | | +| WARNINGTUNNELSUSAGEPRCT | Threshold | | | +| CRITICALTUNNELSUSAGEPRCT | 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 | -|:-------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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 | -|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| -| UNITSTRAFFIC | Units of thresholds for the traffic (Default: 'percent\_delta') ('percent\_delta', 'bps', 'counter') | percent\_delta | | -| UNITSERROR | Units of thresholds for errors/discards (Default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter') | percent\_delta | | -| UNITSCAST | Units of thresholds for communication types (Default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter') | percent\_delta | | -| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Set the interface (number expected) ex: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGINBCAST | Thresholds | | | -| CRITICALINBCAST | Thresholds | | | -| WARNINGINDISCARD | Thresholds | | | -| CRITICALINDISCARD | Thresholds | | | -| WARNINGINERROR | Thresholds | | | -| CRITICALINERROR | Thresholds | | | -| WARNINGINMCAST | Thresholds | | | -| CRITICALINMCAST | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGINUCAST | Thresholds | | | -| CRITICALINUCAST | Thresholds | | | -| WARNINGINVOLUME | | | | -| CRITICALINVOLUME | | | | -| WARNINGOUTBCAST | Thresholds | | | -| CRITICALOUTBCAST | Thresholds | | | -| WARNINGOUTDISCARD | Thresholds | | | -| CRITICALOUTDISCARD | Thresholds | | | -| WARNINGOUTERROR | Thresholds | | | -| CRITICALOUTERROR | Thresholds | | | -| WARNINGOUTMCAST | Thresholds | | | -| CRITICALOUTMCAST | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | -| WARNINGOUTUCAST | Thresholds | | | -| CRITICALOUTUCAST | Thresholds | | | -| WARNINGOUTVOLUME | | | | -| CRITICALOUTVOLUME | | | | -| WARNINGSPEED | Thresholds | | | -| CRITICALSPEED | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (Default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| WARNINGTOTALADMINDOWN | Thresholds | | | -| CRITICALTOTALADMINDOWN | Thresholds | | | -| WARNINGTOTALADMINUP | Thresholds | | | -| CRITICALTOTALADMINUP | Thresholds | | | -| WARNINGTOTALOPERDOWN | Thresholds | | | -| CRITICALTOTALOPERDOWN | Thresholds | | | -| WARNINGTOTALOPERUP | Thresholds | | | -| CRITICALTOTALOPERUP | Thresholds | | | -| WARNINGTOTALPORT | Thresholds | | | -| CRITICALTOTALPORT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose --use-new-perfdata | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| +| UNITSTRAFFIC | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter') | percent\_delta | | +| UNITSERROR | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter') | percent\_delta | | +| UNITSCAST | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter') | percent\_delta | | +| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINBCAST | Threshold | | | +| CRITICALINBCAST | Threshold | | | +| WARNINGINDISCARD | Threshold | | | +| CRITICALINDISCARD | Threshold | | | +| WARNINGINERROR | Threshold | | | +| CRITICALINERROR | Threshold | | | +| WARNINGINMCAST | Threshold | | | +| CRITICALINMCAST | Threshold | | | +| WARNINGINTRAFFIC | Threshold | | | +| CRITICALINTRAFFIC | Threshold | | | +| WARNINGINUCAST | Threshold | | | +| CRITICALINUCAST | Threshold | | | +| WARNINGINVOLUME | Threshold | | | +| CRITICALINVOLUME | Threshold | | | +| WARNINGOUTBCAST | Threshold | | | +| CRITICALOUTBCAST | Threshold | | | +| WARNINGOUTDISCARD | Threshold | | | +| CRITICALOUTDISCARD | Threshold | | | +| WARNINGOUTERROR | Threshold | | | +| CRITICALOUTERROR | Threshold | | | +| WARNINGOUTMCAST | Threshold | | | +| CRITICALOUTMCAST | Threshold | | | +| WARNINGOUTTRAFFIC | Threshold | | | +| CRITICALOUTTRAFFIC | Threshold | | | +| WARNINGOUTUCAST | Threshold | | | +| CRITICALOUTUCAST | Threshold | | | +| WARNINGOUTVOLUME | Threshold | | | +| CRITICALOUTVOLUME | Threshold | | | +| WARNINGSPEED | Threshold | | | +| CRITICALSPEED | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| WARNINGTOTALADMINDOWN | Threshold | | | +| CRITICALTOTALADMINDOWN | Threshold | | | +| WARNINGTOTALADMINUP | Threshold | | | +| CRITICALTOTALADMINUP | Threshold | | | +| WARNINGTOTALOPERDOWN | Threshold | | | +| CRITICALTOTALOPERDOWN | Threshold | | | +| WARNINGTOTALOPERUP | Threshold | | | +| CRITICALTOTALOPERUP | Threshold | | | +| WARNINGTOTALPORT | Threshold | | | +| CRITICALTOTALPORT | 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 --use-new-perfdata | | -| Macro | Description | Default value | Mandatory | -|:--------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGUSAGE | Warning threshold | | | -| CRITICALUSAGE | Critical threshold | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGUSAGE | Warning threshold | | | +| CRITICALUSAGE | 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 | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------|:-----------:| -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (Default: '%\{status\} =~ /not-connected/i'). You can use the following variables: %\{status\}, %\{display\} | %\{status\} =~ /not-connected/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{status\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------|:-----------:| +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\}, %\{display\} | %\{status\} =~ /not-connected/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:---------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGACTIVE | Thresholds. Global: 'active', 'active-prct', (%), 'active-tcp', 'active-udp', 'active-icmp', Per vsys: 'vsys-active', 'vsys-active-prct' (%), 'vsys-active-tcp' 'vsys-active-udp' 'vsys-active-other' | | | -| CRITICALACTIVE | Thresholds. Global: 'active', 'active-prct', (%), 'active-tcp', 'active-udp', 'active-icmp', Per vsys: 'vsys-active', 'vsys-active-prct' (%), 'vsys-active-tcp' 'vsys-active-udp' 'vsys-active-other' | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGACTIVE | Threshold | | | +| CRITICALACTIVE | 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 | -|:-----------------------|:----------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGAVUPDATE | Thresholds | | | -| CRITICALAVUPDATE | Thresholds | | | -| WARNINGTHREATUPDATE | Thresholds | | | -| CRITICALTHREATUPDATE | Thresholds | | | -| WARNINGWILDFIREUPDATE | Thresholds | | | -| CRITICALWILDFIREUPDATE | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (E.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGAVUPDATE | Threshold | | | +| CRITICALAVUPDATE | Threshold | | | +| WARNINGTHREATUPDATE | Threshold | | | +| CRITICALTHREATUPDATE | Threshold | | | +| WARNINGWILDFIREUPDATE | Threshold | | | +| CRITICALWILDFIREUPDATE | 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 | | -3. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). The service appears in the list of services, and on page **Resources Status**. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros. +3. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). The service appears in the list of services, and on the **Resources Status** page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros. ## 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 -is able to monitor a server using a command like this one (replace the sample values by yours): +is able to monitor a resource using a command like this one (replace the sample values by yours): ```bash +/usr/lib/centreon/plugins/centreon_paloalto.pl \ /usr/lib/centreon/plugins/centreon_paloalto.pl \ --plugin=network::paloalto::snmp::plugin \ --mode=sessions \ @@ -458,18 +476,18 @@ the command: The plugin brings the following modes: -| Mode | Linked service template | -|:----------------|:-------------------------------------------------| -| cluster-status | Net-PaloAlto-Standard-Cluster-Status-SNMP-custom | -| cpu | Net-PaloAlto-Standard-Cpu-SNMP-custom | -| gp-usage | Net-PaloAlto-Standard-Global-Protect-SNMP-custom | -| hardware | Net-PaloAlto-Standard-Hardware-SNMP-custom | -| interfaces | Net-PaloAlto-Standard-Interfaces-SNMP-custom | -| list-interfaces | Used for service discovery | -| memory | Net-PaloAlto-Standard-Memory-SNMP-custom | -| panorama | Net-PaloAlto-Standard-Panorama-SNMP-custom | -| sessions | Net-PaloAlto-Standard-Sessions-SNMP-custom | -| signatures | Net-PaloAlto-Standard-Signatures-SNMP-custom | +| Mode | Linked service template | +|:-----------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------| +| cluster-status [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/clusterstatus.pm)] | Net-PaloAlto-Standard-Cluster-Status-SNMP-custom | +| cpu [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/cpu.pm)] | Net-PaloAlto-Standard-Cpu-SNMP-custom | +| gp-usage [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/gpusage.pm)] | Net-PaloAlto-Standard-Global-Protect-SNMP-custom | +| hardware [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/hardwaredevice.pm)] | Net-PaloAlto-Standard-Hardware-SNMP-custom | +| interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-PaloAlto-Standard-Interfaces-SNMP-custom | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | +| memory [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/memory.pm)] | Net-PaloAlto-Standard-Memory-SNMP-custom | +| panorama [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/panorama.pm)] | Net-PaloAlto-Standard-Panorama-SNMP-custom | +| sessions [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/sessions.pm)] | Net-PaloAlto-Standard-Sessions-SNMP-custom | +| signatures [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/paloalto/snmp/mode/signatures.pm)] | Net-PaloAlto-Standard-Signatures-SNMP-custom | ### Available options @@ -477,61 +495,66 @@ The plugin brings the following modes: All generic options are listed here: -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --verbose | Display extended status information (long output). | -| --debug | Display debug messages. | -| --filter-perfdata | Filter perfdata that match the regexp. Eg: 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). Eg: 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). Eg: 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). Eg: 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. Eg: 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. Eg: '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 | #### Modes options @@ -540,137 +563,157 @@ All available options for each service template are listed below: -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------| -| --threshold-overload | Set to overload default threshold value. Example: --threshold-overload='peer,critical,active' --threshold-overload='current,critical,passive' | +| Option | Description | +|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------| +| --threshold-overload | Set to overload default threshold value. Example: --threshold-overload='peer,critical,active' --threshold-overload='current,critical,passive' | -| Option | Description | -|:-------------------------|:---------------------------------------------------------------| -| --warning-* --critical-* | Thresholds. Can be: 'managementplane' (%), 'dataplane' (%). | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* --critical-* | Thresholds. Can be: 'managementplane' (%), 'dataplane' (%). | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------| -| --warning-* --critical-* | Thresholds. Can be: 'tunnels-usage', 'tunnels-usage-free', 'tunnels-usage-prct' (%). | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* --critical-* | Thresholds. Can be: 'tunnels-usage', 'tunnels-usage-free', 'tunnels-usage-prct' (%). | -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (Default: '.*'). Can be: 'device'. | -| --filter | Exclude some parts (comma seperated list) You can also exclude items from specific instances: --filter=device,network.* | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='device.network,OK,down' | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'device'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=device,network.* | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='device.network,OK,down' | +| --warning | Define the warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | +| --critical | Define the critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). package snmp\_standard::mode::components::device; use strict; use warnings; use centreon::plugins::misc; my %map\_status = (1 =\> 'unknown', 2 =\> 'running', 3 =\> 'warning', 4 =\> 'testing', 5 =\> 'down'); my %map\_type = ( '.1.3.6.1.2.1.25.3.1.1' =\> 'other', '.1.3.6.1.2.1.25.3.1.2' =\> 'unknown', '.1.3.6.1.2.1.25.3.1.3' =\> 'processor', '.1.3.6.1.2.1.25.3.1.4' =\> 'network', '.1.3.6.1.2.1.25.3.1.5' =\> 'printer', '.1.3.6.1.2.1.25.3.1.6' =\> 'diskStorage', '.1.3.6.1.2.1.25.3.1.10', =\> 'video', '.1.3.6.1.2.1.25.3.1.11' =\> 'audio', '.1.3.6.1.2.1.25.3.1.12' =\> 'coprocessor', '.1.3.6.1.2.1.25.3.1.13' =\> 'keyboard', '.1.3.6.1.2.1.25.3.1.14' =\> 'modem', '.1.3.6.1.2.1.25.3.1.15' =\> 'parallelPort', '.1.3.6.1.2.1.25.3.1.16' =\> 'pointing', '.1.3.6.1.2.1.25.3.1.17' =\> 'serialPort', '.1.3.6.1.2.1.25.3.1.18' =\> 'tape', '.1.3.6.1.2.1.25.3.1.19' =\> 'clock', '.1.3.6.1.2.1.25.3.1.20' =\> 'volatileMemory', '.1.3.6.1.2.1.25.3.1.21' =\> 'nonVolatileMemory', ); my $mapping = \{ hrDeviceType =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.2', map =\> \%map\_type \}, hrDeviceDescr =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.3' \}, hrDeviceStatus =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.5', map =\> \%map\_status \}, \}; my $oid\_hrDeviceEntry = '.1.3.6.1.2.1.25.3.2.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_hrDeviceEntry \}; \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> "Checking devices"); $self-\>\{components\}-\>\{device\} = \{name =\> 'devices', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'device')); foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_hrDeviceEntry\}\})) \{ next if ($oid !~ /^$mapping-\>\{hrDeviceStatus\}-\>\{oid\}\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_hrDeviceEntry\}, instance =\> $instance); next if ($self-\>check\_filter(section =\> 'device', instance =\> $result-\>\{hrDeviceType\} . '.' . $instance)); $result-\>\{hrDeviceDescr\} = centreon::plugins::misc::trim($result-\>\{hrDeviceDescr\}); $self-\>\{components\}-\>\{device\}-\>\{total\}++; $self-\>\{output\}-\>output\_add(long\_msg =\> sprintf("device '%s' status is '%s' \[instance = %s\]", $result-\>\{hrDeviceDescr\}, $result-\>\{hrDeviceStatus\}, $result-\>\{hrDeviceType\} . '.' . $instance)); my $exit = $self-\>get\_severity(label =\> 'default', section =\> 'device.' . $result-\>\{hrDeviceType\}, value =\> $result-\>\{hrDeviceStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add(severity =\> $exit, short\_msg =\> sprintf("Device '%s' status is '%s'", $result-\>\{hrDeviceDescr\}, $result-\>\{hrDeviceStatus\})); \} \} \} 1; | -| Option | Description | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if redis connection failed. | -| --memexpiration | Time to keep data in seconds (Default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (Default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (Default: 'AES'). | -| --add-global | Check global port statistics (By default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (Default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (Default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (Default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (Default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) ex: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src | Regexp src to transform display value. | -| --display-transform-dst | Regexp dst to transform display value. | -| --show-cache | Display cache interface datas. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if redis connection failed. | -| --memexpiration | Time to keep data in seconds (Default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (Default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (Default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --units | Units of thresholds (Default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage (number expected) ex: 1, 2,... (empty means 'check all storage'). | -| --name | Allows to use storage name with option --storage instead ofstorage oid index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-isensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --show-cache | Display cache storage datas. | -| --filter-storage-type | Filter storage types with a regexp (Default: '^(hrStorageRam\|hrStorageFlashMemory)$'). | +| Option | Description | +|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageRam\|hrStorageFlashMemory)$'). | -| Option | Description | -|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --warning-status | Define the conditions to match for the status to be WARNING (Default: ''). You can use the following variables: %\{status\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (Default: '%\{status\} =~ /not-connected/i'). You can use the following variables: %\{status\}, %\{display\} | +| Option | Description | +|:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-status | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /not-connected/i'). You can use the following variables: %\{status\}, %\{display\} | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --add-vsys | Monitor virtual systems. | -| --filter-vsys-name | Filter virtual systems by name (can be a regexp). | -| --warning-* --critical-* | Thresholds. Global: 'active', 'active-prct', (%), 'active-tcp', 'active-udp', 'active-icmp', Per vsys: 'vsys-active', 'vsys-active-prct' (%), 'vsys-active-tcp' 'vsys-active-udp' 'vsys-active-other'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --add-vsys | Monitor virtual systems. | +| --filter-vsys-name | Filter virtual systems by name (can be a regexp). | +| --warning-* --critical-* | Thresholds. Global: 'active', 'active-prct', (%), 'active-tcp', 'active-udp', 'active-icmp', Per vsys: 'vsys-active', 'vsys-active-prct' (%), 'vsys-active-tcp' 'vsys-active-udp' 'vsys-active-other'. | -| Option | Description | -|:-------------------------|:------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='av-update' | -| --timezone | Timezone options. Default is 'GMT'. | -| --warning-* --critical-* | Thresholds. Can be: 'av-update' (s), 'threat-update' (s), 'wildfire-update' (s). | +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='av-update' | +| --timezone | Timezone options. Default is 'GMT'. | +| --warning-* --critical-* | Thresholds. Can be: 'av-update' (s), 'threat-update' (s), 'wildfire-update' (s). | @@ -681,6 +724,6 @@ All available options for a given mode can be displayed by adding the ```bash /usr/lib/centreon/plugins/centreon_paloalto.pl \ --plugin=network::paloalto::snmp::plugin \ - --mode=cluster-status \ + --mode=panorama \ --help ``` diff --git a/pp/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-ssh.md b/pp/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-ssh.md index d9be6b65955f..2fb01ff4bcd4 100644 --- a/pp/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-ssh.md +++ b/pp/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-ssh.md @@ -39,12 +39,21 @@ Here is the list of services for this connector, detailing all metrics linked to -Coming soon +| Name | Unit | +|:-----------------------------|:------| +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | +| hardware.voltage.status | N/A | +| hardware.voltage.count | count | +| hardware.voltage.volt | V | -| Metric name | Unit | +| Name | Unit | |:----------------------------|:------| | sync-status | N/A | | *member*~member-status | N/A | @@ -53,7 +62,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:-----------------------|:------| | interfaces.total.count | count | | *interface*#status | N/A | @@ -61,7 +70,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:--------------------------|:------| | tunnels.ipsec.total.count | count | | *tunnels*#status | N/A | @@ -69,7 +78,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:------------------|:------| | *features*#status | N/A | @@ -78,7 +87,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:-----------------------------------------|:------| | status | N/A | | system.antivirus.lastupdate.time.seconds | s | diff --git a/pp/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md b/pp/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md index 7ad8fc93402f..dd03129215a6 100644 --- a/pp/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md +++ b/pp/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md @@ -1,15 +1,21 @@ --- id: network-firewalls-stonesoft -title: Stonesoft +title: Stonesoft SNMP --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Stonesoft SNMP** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates -The Monitoring Connector **Stonesoft** brings a host template: +The Monitoring Connector **Stonesoft SNMP** brings a host template: * **Net-Stonesoft-SNMP-custom** @@ -20,26 +26,26 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:-----------------|:-------------------------------------------|:--------------------------------------------| -| Connections | Net-Stonesoft-Connections-SNMP-custom | Check connections. | -| Cpu | Net-Stonesoft-Cpu-SNMP-custom | Check the rate of utilization of CPU. | -| Dropped-Packets | Net-Stonesoft-Dropped-Packets-SNMP-custom | Check count of dropped packets. | -| Memory | Net-Stonesoft-Memory-SNMP-custom | Check the rate of the utilization of memory. | -| Rejected-Packets | Net-Stonesoft-Rejected-Packets-SNMP-custom | Check count of rejected packets. | +| Connections | Net-Stonesoft-Connections-SNMP-custom | Check connections | +| Cpu | Net-Stonesoft-Cpu-SNMP-custom | Check the rate of utilization of CPU | +| Dropped-Packets | Net-Stonesoft-Dropped-Packets-SNMP-custom | Check count of dropped packets | +| Memory | Net-Stonesoft-Memory-SNMP-custom | Check the rate of the utilization of memory | +| Rejected-Packets | Net-Stonesoft-Rejected-Packets-SNMP-custom | Check count of rejected packets | > The services listed above are created automatically when the **Net-Stonesoft-SNMP-custom** host template is used. -| Service Alias | Service Template | Service Description | Discovery | -|:---------------------|:-----------------------------------------------|:---------------------------------------|:----------:| -| Cluster-Load | Net-Stonesoft-Cluster-Load-SNMP-custom | Check the load of the cluster. | | -| Cluster-State | Net-Stonesoft-Cluster-State-SNMP-custom | Check the state of the cluster. | | -| Disk-Global | Net-Stonesoft-Disk-Global-SNMP-custom | Check the rate of utilization on disks. | | -| Disk-Name | Net-Stonesoft-Disk-Name-SNMP-custom | Check the rate of utilization on disks. | | -| Traffic-Generic-ID | Net-Stonesoft-Traffic-Generic-ID-SNMP-custom | Check the bandwidth of the interface. | | -| Traffic-Generic-Name | Net-Stonesoft-Traffic-Generic-Name-SNMP-custom | Check the bandwidth of the interface. | | -| Traffic-Global | Net-Stonesoft-Traffic-Global-SNMP-custom | Check the bandwidth of the interface. | X | +| Service Alias | Service Template | Service Description | Discovery | +|:---------------------|:-----------------------------------------------|:---------------------------------------|:---------:| +| Cluster-Load | Net-Stonesoft-Cluster-Load-SNMP-custom | Check the load of the cluster | | +| Cluster-State | Net-Stonesoft-Cluster-State-SNMP-custom | Check the state of the cluster | | +| Disk-Global | Net-Stonesoft-Disk-Global-SNMP-custom | Check the rate of utilization on disks | | +| Disk-Name | Net-Stonesoft-Disk-Name-SNMP-custom | Check the rate of utilization on disks | | +| Traffic-Generic-ID | Net-Stonesoft-Traffic-Generic-ID-SNMP-custom | Check the bandwidth of the interface | | +| Traffic-Generic-Name | Net-Stonesoft-Traffic-Generic-Name-SNMP-custom | Check the bandwidth of the interface | | +| Traffic-Global | Net-Stonesoft-Traffic-Global-SNMP-custom | Check the bandwidth of the interface | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -54,35 +60,35 @@ The connector brings the following service templates (sorted by the host templat | Rule name | Description | |:--------------------------------|:--------------------------------------------------------------| -| Net-StoneSoft-SNMP-Traffic-Name | Discover network interfaces and monitor bandwidth utilization. | +| Net-StoneSoft-SNMP-Traffic-Name | Discover network interfaces and monitor bandwidth utilization | More information about discovering services automatically is available on the [dedicated page](/docs/monitoring/discovery/services-discovery) and in the [following chapter](/docs/monitoring/discovery/services-discovery/#discovery-rules). ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | -|:------------|:------| -| cpuload | % | +| Name | Unit | +|:--------|:------| +| cpuload | % | -| Metric name | Unit | -|:------------|:------| -| status | N/A | +| Name | Unit | +|:-------|:------| +| status | N/A | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | +| Name | Unit | |:----------------------------|:------| | connections.total.count | con | | connections.total.persecond | con/s | @@ -92,59 +98,65 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | +| Name | Unit | |:--------------|:------| | total_cpu_avg | % | -Coming soon +| Name | Unit | +|:-----|:-----| +| free | B | +| used | B | -Coming soon +| Name | Unit | +|:-----|:-----| +| free | B | +| used | B | -| Metric name | Unit | +| Name | Unit | |:------------------------|:------| | dropped_packets_per_sec | N/A | -| Metric name | Unit | -|:------------|:------| -| cached | B | -| buffer | B | -| used | B | -| swap | B | +| Name | Unit | +|:-------|:------| +| cached | B | +| buffer | B | +| used | B | +| swap | B | -| Metric name | Unit | +| Name | Unit | |:-------------------------|:------| | rejected_packets_per_sec | N/A | -| Metric name | Unit | +| Name | Unit | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | -| Metric name | Unit | +| Name | Unit | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | @@ -157,7 +169,10 @@ Coming soon ### 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 @@ -167,12 +182,9 @@ The target resource must be reachable from the Centreon poller on the UDP/161 SN ### 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: @@ -207,8 +219,8 @@ yum install centreon-pack-network-firewalls-stonesoft -2. Whatever the license type (*online* or *offline*), install the **Stonesoft** connector through -the **Configuration > Monitoring Connectors Manager** menu. +2. Whatever the license type (*online* or *offline*), install the **Stonesoft SNMP** connector through +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -259,12 +271,12 @@ yum install centreon-plugin-Network-Firewalls-Stonesoft ### Using a host template provided by the connector 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-Stonesoft-SNMP-custom** template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior. 4. Fill in the macros you want. Some macros are mandatory. -| Macro | Description | Default value | Mandatory | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| Macro | Description | Default value | Mandatory | +|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 5. [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. @@ -277,120 +289,120 @@ yum install centreon-plugin-Network-Firewalls-Stonesoft -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | | | | -| CRITICAL | | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Threshold | | | +| CRITICAL | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:--------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| CRITICALCONNECTIONS | Critical threshold | | | -| WARNINGCONNECTIONS | Warning threshold | | | +| Macro | Description | Default value | Mandatory | +|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CRITICALCONNECTIONS | Threshold | | | +| WARNINGCONNECTIONS | 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 | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| CRITICAL | Critical threshold in percent | 90 | | -| WARNING | Warning threshold in percent | 80 | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CRITICAL | Critical threshold in percent | 90 | | +| WARNING | Warning threshold in percent | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the storage name (empty means 'check all storage') | ^(?!(/)$) | | -| CRITICAL | Critical threshold | 90 | | -| WARNING | Warning threshold | 80 | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Set the storage name (empty means 'check all storage') | ^(?!(/)$) | | +| CRITICAL | Critical threshold | 90 | | +| WARNING | Warning threshold | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| DISKNAME | Set the storage name (empty means 'check all storage') | | | -| WARNING | Warning threshold | | | -| CRITICAL | Critical threshold | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| DISKNAME | Set the storage name (empty means 'check all storage') | | | +| WARNING | Warning threshold | | | +| CRITICAL | Critical threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold for dropped packets per second | | | -| CRITICAL | Critical threshold for dropped packets per second | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold for dropped packets per second | | | +| CRITICAL | Critical threshold for dropped packets per second | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent | 80 | | -| CRITICAL | Critical threshold in percent. -swap Check swap also | 90 | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent | 80 | | +| CRITICAL | Critical threshold in percent | 90 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold for blocked packets per second | | | -| CRITICAL | Critical threshold for blocked packets per second | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold for blocked packets per second | | | +| CRITICAL | Critical threshold for blocked packets per second | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGIN | Thresholds | | | -| CRITICALIN | Thresholds | | | -| WARNINGOUT | Thresholds | | | -| CRITICALOUT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Threshold | | | +| CRITICALIN | Threshold | | | +| WARNINGOUT | Threshold | | | +| CRITICALOUT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGIN | Thresholds | | | -| CRITICALIN | Thresholds | | | -| WARNINGOUT | Thresholds | | | -| CRITICALOUT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGIN | Threshold | | | +| CRITICALIN | Threshold | | | +| WARNINGOUT | Threshold | | | +| CRITICALOUT | Threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | .* | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -400,7 +412,7 @@ yum install centreon-plugin-Network-Firewalls-Stonesoft ## 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 @@ -437,7 +449,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 @@ -470,281 +482,275 @@ 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 an "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %\{variable\} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. | -| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '\_max' suffix). Example: it will split 'used\_prct'=26.93%;0:80;0:90;0;100 into 'used\_prct'=26.93%;0:80;0:90;0;100 'used\_prct\_max'=100%;;;; | -| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[m ax\]\] Common examples: Convert storage free perfdata into used: --change-perfdata=free,used,invert() Convert storage free perfdata into used: --change-perfdata=used,free,invert() Scale traffic values automatically: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic\_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic\_in,,percent() | -| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard \|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traf fic\_(in\|out)\_$1)' | -| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | -| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | -| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | -| --filter-uom | Mask the units when they don't match the given regular expression. | -| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | -| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | -| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | -| --output-xml | Return the output in XML format (to send to an XML API). | -| --output-json | Return the output in JSON format (to send to a JSON API). | -| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | -| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | -| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | -| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | -| --float-precision | Define the float precision for thresholds (default: 8). | -| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. | -| --hostname | Name or address of the host to monitor (mandatory). | -| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | -| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | -| --snmp-port | UDP port to send the SNMP request to (default: 161). | -| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | -| --snmp-retries | Maximum number of retries (default: 5). | -| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | -| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | -| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | -| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | -| --snmp-cache-file | Use SNMP cache file. | -| --snmp-username | SNMP v3 only: User name (securityName). | -| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | -| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | -| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | -| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | -| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | -| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | -| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | -| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | -| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | -| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | -| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | -| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | -| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | +| Option | Description | +|:-------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). | +| --dyn-mode | Specify a mode with the module's path (advanced). | +| --list-mode | List all available modes. | +| --mode-version | Check minimal version of mode. If not, unknown error. | +| --version | Return the version of the plugin. | +| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | +| --hostname | Name or address of the host to monitor (mandatory). | +| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | +| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | +| --snmp-port | UDP port to send the SNMP request to (default: 161). | +| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | +| --snmp-retries | Maximum number of retries (default: 5). | +| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | +| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | +| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | +| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | +| --snmp-cache-file | Use SNMP cache file. | +| --snmp-username | SNMP v3 only: User name (securityName). | +| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | +| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | +| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | +| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | +| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | +| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | +| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | +| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | +| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | +| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | +| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | +| --verbose | Display extended status information (long output). | +| --debug | Display debug messages. | +| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | +| --filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %\{variable\} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. | +| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '\_max' suffix. Example: it will split 'used\_prct'=26.93%;0:80;0:90;0;100 into 'used\_prct'=26.93%;0:80;0:90;0;100 'used\_prct\_max'=100%;;;; | +| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[\\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,\,calculation\[,\[\\],\[min\],\[max\]\] regex: regular expression \: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated \ (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard\|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traffic\_(in\|out)\_$1)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --change-output-adv | Replace short output and exit code based on a "if" condition using the following variables: short\_output, exit\_code. Variables must be written either %\{variable\} or %(variable). Example: adding --change-output-adv='%(short\_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | #### Modes options All available options for each service template are listed below: - - -| Option | Description | -|:-------|:------------| - - -| Option | Description | -|:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{node_status\} =~ /unknown/i'). You can use the following variables: %\{node_status\}, %\{node_member_id\}. | -| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{node_status\} =~ /lockedOnline/i'). You can use the following variables: %\{node_status\}, %\{node_member_id\}. | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{node_status\} =~ /^(?:offline\|goingOffline\|lockedOffline\|goingLockedOffline\|stand by\|goingStandby)$/i'). You can use the following variables: %\{node_status\}, %\{node_member_id\}. | +| Option | Description | +|:------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: '%\{node\_status\} =~ /unknown/i'). You can use the following variables: %\{node\_status\}, %\{node\_member\_id\}. | +| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{node\_status\} =~ /lockedOnline/i'). You can use the following variables: %\{node\_status\}, %\{node\_member\_id\}. | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{node\_status\} =~ /^(?:offline\|goingOffline\|lockedOffline\|goingLockedOffline\|standby\|goingStandby)$/i'). You can use the following variables: %\{node\_status\}, %\{node\_member\_id\}. | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-* | Warning threshold. Can be: 'connections', 'rate-connections'. | -| --critical-* | Critical threshold. Can be: 'connections', 'rate-connections'. | +| Option | Description | +|:------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* | Warning threshold. Can be: 'connections', 'rate-connections'. | +| --critical-* | Critical threshold. Can be: 'connections', 'rate-connections'. | -| Option | Description | -|:-----------|:----------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. | +| Option | Description | +|:-----------|:------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | -| Option | Description | -|:---------------------|:------------------------------------------------------------| -| --warning | Warning threshold. | -| --critical | Critical threshold. | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage name (empty means 'check all storage'). | -| --regexp | Allows to use regexp to filter storage. | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| Option | Description | +|:---------------------|:--------------------------------------------------------------| +| --warning | Warning threshold. | +| --critical | Critical threshold. | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage name (empty means 'check all storage'). | +| --regexp | Allows to use regexp to filter storage. | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| Option | Description | -|:---------------------|:------------------------------------------------------------| -| --warning | Warning threshold. | -| --critical | Critical threshold. | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage name (empty means 'check all storage'). | -| --regexp | Allows to use regexp to filter storage. | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| Option | Description | +|:---------------------|:--------------------------------------------------------------| +| --warning | Warning threshold. | +| --critical | Critical threshold. | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage name (empty means 'check all storage'). | +| --regexp | Allows to use regexp to filter storage. | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning | Warning threshold for dropped packets per second. | -| --critical | Critical threshold for dropped packets per second. | +| Option | Description | +|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning | Warning threshold for dropped packets per second. | +| --critical | Critical threshold for dropped packets per second. | -| Option | Description | -|:----------------|:---------------------------------------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. -swap Check swap also. | -| --warning-swap | Warning threshold in percent. | -| --critical-swap | Critical threshold in percent. | -| --no-swap | Threshold if no active swap (default: 'critical'). | +| Option | Description | +|:----------------|:--------------------------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | +| --swap | Check swap also. | +| --warning-swap | Warning threshold in percent. | +| --critical-swap | Critical threshold in percent. | +| --no-swap | Threshold if no active swap (default: 'critical'). | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning | Warning threshold for blocked packets per second. | -| --critical | Critical threshold for blocked packets per second. | +| Option | Description | +|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning | Warning threshold for blocked packets per second. | +| --critical | Critical threshold for blocked packets per second. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface datas. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface datas. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | diff --git a/pp/integrations/plugin-packs/procedures/network-hp-vc-snmp.md b/pp/integrations/plugin-packs/procedures/network-hp-vc-snmp.md index b5487f90bbf5..94569f73d4dd 100644 --- a/pp/integrations/plugin-packs/procedures/network-hp-vc-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-hp-vc-snmp.md @@ -66,12 +66,32 @@ Here is the list of services for this connector, detailing all metrics linked to -Coming soon +| Name | Unit | +|:--------------------------------------|:------| +| hardware.domain.status | N/A | +| hardware.domain.count | count | +| hardware.enclosure.status | N/A | +| hardware.enclosure.count | count | +| hardware.enet.status | N/A | +| hardware.enet.count | count | +| hardware.fc.status | N/A | +| hardware.fc.count | count | +| hardware.module.status | N/A | +| hardware.module.count | count | +| hardware.moduleport.loop.status | N/A | +| hardware.moduleport.protection.status | N/A | +| hardware.moduleport.count | count | +| hardware.physicalserver.status | N/A | +| hardware.physicalserver.count | count | +| hardware.port.status | N/A | +| hardware.port.count | count | +| hardware.profile.status | N/A | +| hardware.profile.count | count | -| Metric name | Unit | +| Name | Unit | |:-----------------------------------------------------|:------| | *interface_name*#status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | diff --git a/pp/integrations/plugin-packs/procedures/network-switchs-alcatel-omniswitch-snmp.md b/pp/integrations/plugin-packs/procedures/network-switchs-alcatel-omniswitch-snmp.md index 5e3649714639..00549f0a6921 100644 --- a/pp/integrations/plugin-packs/procedures/network-switchs-alcatel-omniswitch-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-switchs-alcatel-omniswitch-snmp.md @@ -5,6 +5,12 @@ title: Alcatel Omniswitch import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Alcatel Omniswitch** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates @@ -30,11 +36,11 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:----------------|:---------------------------------------------------|:----------------------------------------|:----------:| -| Interfaces | Net-Alcatel-Omniswitch-Interfaces-SNMP-custom | Check interfaces | X | -| Spanning-Tree | Net-Alcatel-Omniswitch-SpanningTree-SNMP-custom | Check Spanning Tree state on interfaces | | -| Virtual-Chassis | Net-Alcatel-Omniswitch-Virtual-Chassis-SNMP-custom | Check virtual chassis | | +| Service Alias | Service Template | Service Description | Discovery | +|:----------------|:---------------------------------------------------|:----------------------------------------|:---------:| +| Interfaces | Net-Alcatel-Omniswitch-Interfaces-SNMP-custom | Check interfaces | X | +| Spanning-Tree | Net-Alcatel-Omniswitch-SpanningTree-SNMP-custom | Check Spanning Tree state on interfaces | | +| Virtual-Chassis | Net-Alcatel-Omniswitch-Virtual-Chassis-SNMP-custom | Check virtual chassis | | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -47,9 +53,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Alcatel-OmniSwitch-SNMP-custom** host template | +| Rule name | Description | +|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Alcatel-OmniSwitch-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -64,17 +70,20 @@ and in the [following chapter](/docs/monitoring/discovery/services-discovery/#di ### 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. -Coming soon +| Name | Unit | +|:------|:-----| +| cpu1m | % | +| cpu1h | % | -| Metric name | Unit | +| Name | Unit | |:---------------------------|:------| | *memory*#flash.usage.bytes | B | @@ -83,14 +92,45 @@ Coming soon -Coming soon +| Name | Unit | +|:--------------------------------|:------| +| hardware.backplane.status | N/A | +| hardware.backplane.count | count | +| hardware.backplane.power.watt | W | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | +| hardware.container.status | N/A | +| hardware.container.count | count | +| hardware.container.power.watt | W | +| hardware.fan.status | N/A | +| hardware.fan.count | count | +| hardware.fan.power.watt | W | +| hardware.module.status | N/A | +| hardware.module.count | count | +| hardware.module.power.watt | W | +| hardware.other.status | N/A | +| hardware.other.count | count | +| hardware.other.power.watt | W | +| hardware.port.status | N/A | +| hardware.port.count | count | +| hardware.port.power.watt | W | +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.powersupply.power.watt | W | +| hardware.sensor.status | N/A | +| hardware.sensor.count | count | +| hardware.sensor.power.watt | W | +| hardware.stack.status | N/A | +| hardware.stack.count | count | +| hardware.stack.power.watt | W | -| Metric name | Unit | +| Name | Unit | |:----------------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | | *interface_name*#interface.packets.in.discard.percentage | % | @@ -101,24 +141,28 @@ Coming soon -Coming soon +| Name | Unit | +|:------|:-----| +| mem1m | % | +| mem1h | % | -| Metric name | Unit | -|:-----------------------|:------| -| *spanningtrees*#status | N/A | +| Name | Unit | +|:-------|:------| +| status | N/A | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -| Metric name | Unit | -|:-------------------------|:------| -| chassis.detected.count | count | -| *chassis*#chassis-status | N/A | +| Name | Unit | +|:-----------------------|:------| +| chassis.detected.count | count | +| chassis-status | N/A | +| chassis-status | N/A | @@ -141,12 +185,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: @@ -182,7 +223,7 @@ yum install centreon-pack-network-switchs-alcatel-omniswitch-snmp 2. Whatever the license type (*online* or *offline*), install the **Alcatel Omniswitch** connector through -the **Configuration > Monitoring Connectors Manager** menu. +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -233,15 +274,15 @@ yum install centreon-plugin-Network-Switchs-Alcatel-Omniswitch-Snmp ### Using a host template provided by the connector 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. 3. Apply the **Net-Alcatel-OmniSwitch-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 (e.g. a --verbose flag). 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. @@ -253,81 +294,81 @@ yum install centreon-plugin-Network-Switchs-Alcatel-Omniswitch-Snmp -| Macro | Description | Default value | Mandatory | -|:-------------|:--------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent (1m,1h) | | | -| CRITICAL | Critical threshold in percent (1m,1h) | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). All options are listed [here](#available-options) | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent (1m,1h) | | | +| CRITICAL | Critical threshold in percent (1m,1h) | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:--------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent | | | -| CRITICAL | Critical threshold in percent | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). All options are listed [here](#available-options) | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent | | | +| CRITICAL | Critical threshold in percent | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:--------------------------------------------------------------------------------------------|:------------------|:-----------:| -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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 | -|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| -| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| WARNINGINDISCARD | Thresholds | | | -| CRITICALINDISCARD | Thresholds | | | -| WARNINGINERROR | Thresholds | | | -| CRITICALINERROR | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGOUTDISCARD | Thresholds | | | -| CRITICALOUTDISCARD | Thresholds | | | -| WARNINGOUTERROR | Thresholds | | | -| CRITICALOUTERROR | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| +| OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINDISCARD | Threshold | | | +| CRITICALINDISCARD | Threshold | | | +| WARNINGINERROR | Threshold | | | +| CRITICALINERROR | Threshold | | | +| WARNINGINTRAFFIC | Threshold | | | +| CRITICALINTRAFFIC | Threshold | | | +| WARNINGOUTDISCARD | Threshold | | | +| CRITICALOUTDISCARD | Threshold | | | +| WARNINGOUTERROR | Threshold | | | +| CRITICALOUTERROR | Threshold | | | +| WARNINGOUTTRAFFIC | Threshold | | | +| CRITICALOUTTRAFFIC | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:--------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING | Warning threshold in percent (1m,1h) | | | -| CRITICAL | Critical threshold in percent (1m,1h) | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). All options are listed [here](#available-options) | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING | Warning threshold in percent (1m,1h) | | | +| CRITICAL | Critical threshold in percent (1m,1h) | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| -| FILTERPORT | Filter on port description (can be a regexp) | .* | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{op_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op_status\}, %\{admin_status\}, %\{port\}, %\{index\} | %\{state\} =~ /blocking\|broken/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op_status\}, %\{admin_status\}, %\{port\}, %\{index\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------|:-----------:| +| FILTERPORT | Filter on port description (can be a regexp) | .* | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\} | %\{state\} =~ /blocking\|broken/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\} | | | +| 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 | -|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------|:-----------:| -| WARNINGCHASSISDETECTED | Thresholds | | | -| CRITICALCHASSISDETECTED | Thresholds | | | -| CRITICALCHASSISSTATUS | Define the conditions to match for the status to be CRITICAL (default: %\{status\} !~ /init\|running/) You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | %\{status\} !~ /init\|running/ | | -| WARNINGCHASSISSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (e.g. a --verbose flag). All options are listed [here](#available-options) | --verbose | | +| Macro | Description | Default value | Mandatory | +|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------|:-----------:| +| WARNINGCHASSISDETECTED | Threshold | | | +| CRITICALCHASSISDETECTED | Threshold | | | +| CRITICALCHASSISSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | %\{status\} !~ /init\|running/ | | +| WARNINGCHASSISSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | | | +| 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 | | @@ -343,38 +384,21 @@ is able to monitor a resource using a command like this one (replace the sample ```bash /usr/lib/centreon/plugins/centreon_alcatel_omniswitch_snmp.pl \ --plugin=network::alcatel::omniswitch::snmp::plugin \ - --mode=interfaces \ + --mode=virtual-chassis \ --hostname='10.0.0.1' \ --snmp-version='2c' \ --snmp-community='my-snmp-community' \ - --interface='' \ - --name \ - --add-status \ - --add-traffic \ - --add-errors \ - --warning-status='' \ - --critical-status='%\{admstatus\} eq "up" and %\{opstatus\} !~ /up|dormant/' \ - --warning-in-traffic='' \ - --critical-in-traffic='' \ - --warning-out-traffic='' \ - --critical-out-traffic='' \ - --warning-in-discard='' \ - --critical-in-discard='' \ - --warning-out-discard='' \ - --critical-out-discard='' \ - --warning-in-error='' \ - --critical-in-error='' \ - --warning-out-error='' \ - --critical-out-error='' \ - --oid-filter='ifname' \ - --oid-display='ifname' \ + --warning-chassis-status='' \ + --critical-chassis-status='%\{status\} !~ /init|running/' \ + --warning-chassis-detected='' \ + --critical-chassis-detected='' \ --verbose ``` The expected command output is shown below: ```bash -OK: All interfaces are ok | '*interface_name*#status'='up';;;;'*interface_name*#interface.traffic.in.bitspersecond'=20b/s;;;;'*interface_name*#interface.traffic.out.bitspersecond'=20b/s;;;; +OK: detected chassis: 8 All virtual chassis are ok | 'chassis.detected.count'=8;;;0; ``` ### Troubleshooting @@ -418,61 +442,66 @@ The plugin brings the following modes: All generic options are listed here: -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --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 | #### Modes options @@ -481,103 +510,108 @@ All available options for each service template are listed below: -| Option | Description | -|:-----------|:------------------------------------------| -| --warning | Warning threshold in percent (1m,1h). | -| --critical | Critical threshold in percent (1m,1h). | +| Option | Description | +|:-----------|:-------------------------------------------------| +| --warning | Warning threshold in percent (1m,1h). | +| --critical | Critical threshold in percent (1m,1h). | -| Option | Description | -|:-----------------|:----------------------------------| -| --warning-usage | Warning threshold in percent. | -| --critical-usage | Critical threshold in percent. | +| Option | Description | +|:------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-usage | Warning threshold in percent. | +| --critical-usage | Critical threshold in percent. | -| Option | Description | -|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'other', 'unknown', 'chassis', 'backplane', 'container', 'psu', 'fan', 'sensor', 'module', 'port, 'stack'. Some not exists ;) | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan). You can also exclude items from specific instances: --filter=fan,1.2 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu.oper,CRITICAL,standby' | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'other', 'unknown', 'chassis', 'backplane', 'container', 'psu', 'fan', 'sensor', 'module', 'port, 'stack'. Some not exists ;) | +| --filter | Exclude the items given as a comma-separated list (example: --filter=fan). You can also exclude items from specific instances: --filter=fan,1.2 | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu.oper,CRITICAL,standby' | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface datas. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | -| Option | Description | -|:-----------|:------------------------------------------| -| --warning | Warning threshold in percent (1m,1h). | -| --critical | Critical threshold in percent (1m,1h). | +| Option | Description | +|:-----------|:--------------------------------------------| +| --warning | Warning threshold in percent (1m,1h). | +| --critical | Critical threshold in percent (1m,1h). | -| Option | Description | -|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --filter-port | Filter on port description (can be a regexp). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op_status\}, %\{admin_status\}, %\{port\}, %\{index\}. | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op_status\}, %\{admin_status\}, %\{port\}, %\{index\}. | +| Option | Description | +|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --filter-port | Filter on port description (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{op\_status\} =~ /up/ && %\{state\} =~ /blocking\|broken/'). You can use the following variables: %\{state\}, %\{op\_status\}, %\{admin\_status\}, %\{port\}, %\{index\}. | -| Option | Description | -|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --unknown-chassis-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | -| --warning-chassis-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | -| --critical-chassis-status | Define the conditions to match for the status to be CRITICAL (default: %\{status\} !~ /init\|running/) You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | -| --warning-* --critical-* | Thresholds. Can be: 'chassis-detected'. | +| Option | Description | +|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --unknown-chassis-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | +| --warning-chassis-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | +| --critical-chassis-status | Define the conditions to match for the status to be CRITICAL (default: %\{status\} !~ /init\|running/) You can use the following variables: %\{role\}, %\{status\}, %\{mac\} | +| --warning-* --critical-* | Thresholds. Can be: 'chassis-detected'. | @@ -588,6 +622,6 @@ All available options for a given mode can be displayed by adding the ```bash /usr/lib/centreon/plugins/centreon_alcatel_omniswitch_snmp.pl \ --plugin=network::alcatel::omniswitch::snmp::plugin \ - --mode=interfaces \ + --mode=virtual-chassis \ --help ``` From e7200c3ead7d641283793ebb0bf4f1c7893816eb Mon Sep 17 00:00:00 2001 From: lucie-tirand Date: Mon, 3 Nov 2025 10:11:21 +0100 Subject: [PATCH 2/3] remove coming soon in metrics page 2 and 3 CTOR-1944 --- .../procedures/applications-protocol-udp.md | 244 +++---- .../hardware-devices-aeg-acm-snmp.md | 122 ++-- .../procedures/network-cisco-ironport-snmp.md | 519 +++++++-------- .../procedures/network-perle-ids-snmp.md | 458 ++++++------- .../procedures/network-watchguard-snmp.md | 615 +++++++++--------- .../procedures/applications-protocol-udp.md | 241 +++---- .../hardware-devices-aeg-acm-snmp.md | 132 ++-- .../procedures/network-cisco-ironport-snmp.md | 519 +++++++-------- .../procedures/network-perle-ids-snmp.md | 461 ++++++------- .../procedures/network-watchguard-snmp.md | 612 +++++++++-------- 10 files changed, 2004 insertions(+), 1919 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-udp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-udp.md index 9da555568e4a..24cca4ad62e6 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-udp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-udp.md @@ -5,65 +5,76 @@ title: Protocol UDP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Contenu du Pack +## Dépendances du connecteur de supervision + +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Protocol UDP** +depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : +* [Base Pack](./base-generic.md) + +## Contenu du pack ### Modèles Le connecteur de supervision **Protocol UDP** apporte 2 modèles d'hôte : -* App-Protocol-Udp -* App-Protocol-Udp-Only +* **App-Protocol-Udp-custom** +* **App-Protocol-Udp-Only-custom** -Le connecteur apporte le modèle de service suivant (classés par modèle d'hôte): +Le connecteur apporte le modèle de service suivant +(classé selon le modèle d'hôte auquel il est rattaché) : - + -| Alias | Modèle de service | Description | -|:------|:------------------|:------------| -| N/A | N/A | N/A | +Ce modèle d'hôte n'apporte pas de modèle de service. - + -| Alias | Modèle de service | Description | -|:------|:------------------|:------------| -| N/A | N/A | N/A | +Ce modèle d'hôte n'apporte pas de modèle de service. - + -| Alias | Modèle de service | Description | -|:-----------|:----------------------------|:-------------------------------| -| Connection | App-Protocol-Udp-Connection | Contrôle l'accès à un port UDP | +| Alias | Modèle de service | Description | +|:-----------|:-----------------------------------|:-------------------------------| +| Connection | App-Protocol-Udp-Connection-custom | Contrôle l'accès à un port UDP | -> Ces services ne sont pas automatiquement créés lorsque le modèle d'hôte est appliqué. +> Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. - - ### Métriques & statuts collectés +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. + -Coming soon +| Nom | Unité | +|:-------|:------| +| status | N/A | -## Installation +## Prérequis + +The SNMP agent must be enabled and configured on the resource. Please refer to the official documentation from the manufacturer/publisher. +Your resource may require a list of addresses authorized to query it to be set up. +Please ensure that the addresses of the Centreon pollers are included in this list. + +## Installer le connecteur de supervision ### Pack -La procédure d'installation des connecteurs de supervision diffère légèrement [suivant que votre licence est offline ou online](../getting-started/how-to-guides/connectors-licenses.md). de supervision +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). -Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet -n'est pas requise pour voir apparaître le pack dans le menu **Configuration > Connecteurs > Connecteurs de supervision**. +1. Si la plateforme est configurée avec une licence *online*, l'installation d'un paquet +n'est pas requise pour voir apparaître le connecteur dans le menu **Configuration > Connecteurs > Connecteurs de supervision**. Au contraire, si la plateforme utilise une licence *offline*, installez le paquet -sur le **serveur central** via la commande correspondant au gestionnaire de paquet +sur le **serveur central** via la commande correspondant au gestionnaire de paquets associé à sa distribution : @@ -97,13 +108,13 @@ yum install centreon-pack-applications-protocol-udp -Quel que soit le type de la licence (*online* ou *offline*), installez le Pack **Protocol UDP** +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Protocol UDP** depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. ### Plugin À partir de Centreon 22.04, il est possible de demander le déploiement automatique -du plugin lors de l'utilisation d'un pack. Si cette fonctionnalité est activée, et +du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise. @@ -112,97 +123,104 @@ que vous ne souhaitez pas découvrir des éléments pour la première fois, alor Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation : - + ```bash dnf install centreon-plugin-Applications-Protocol-Udp ``` - + ```bash dnf install centreon-plugin-Applications-Protocol-Udp ``` - + ```bash -yum install centreon-plugin-Applications-Protocol-Udp +apt install centreon-plugin-applications-protocol-udp ``` - + ```bash -apt install centreon-plugin-applications-protocol-udp +yum install centreon-plugin-Applications-Protocol-Udp ``` -## Configuration +## Utiliser le connecteur de supervision -### Hôte +### Utiliser un modèle d'hôte issu du connecteur - + 1. Ajoutez un hôte à Centreon depuis la page **Configuration > Hôtes**. 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. -3. Appliquez le modèle d'hôte **App-Protocol-Udp-custom**. +3. Appliquez le modèle d'hôte **App-Protocol-Udp-custom**. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur. -| Obligatoire | Macro | Description | Défaut | -|:------------|:-----------|:------------|:--------| -| | UDPPORT | | 161 | -| | UDPTIMEOUT | | 3 | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------|:--------------|:------------------|:-----------:| +| UDPPORT | Port used | 161 | | +| UDPTIMEOUT | Timeout value | 3 | | + +5. [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. - + 1. Ajoutez un hôte à Centreon depuis la page **Configuration > Hôtes**. 2. Complétez les champs **Nom**, **Alias** & **IP Address/DNS** correspondant à votre ressource. -3. Appliquez le modèle d'hôte **App-Protocol-Udp-Only-custom**. -4. Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (**Obligatoire**) doivent être renseignées. +3. Appliquez le modèle d'hôte **App-Protocol-Udp-Only-custom**. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur. +4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires. + +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------|:--------------|:------------------|:-----------:| +| UDPPORT | Port used | 161 | | +| UDPTIMEOUT | Timeout value | 3 | | -| Obligatoire | Macro | Description | Défaut | -|:------------|:-----------|:------------|:--------| -| | UDPPORT | | 161 | -| | UDPTIMEOUT | | 3 | +5. [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. +### Utiliser un modèle de service issu du connecteur -### Service - -Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (**Obligatoire**) doivent être renseignées. +1. Si vous avez utilisé un modèle d'hôte et coché la case **Créer aussi les services liés aux modèles**, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, [créez les services désirés manuellement](/docs/monitoring/basic-objects/services) et appliquez-leur un modèle de service. +2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (**Obligatoire**) doivent être renseignées. -| Obligatoire | Macro | Description | Défaut | -|:------------|:-------------|:--------------------------------------------------------------------------------|:--------| -| | PORT | Port used | | -| | EXTRAOPTIONS | Any extra option you may want to add to the command line (eg. a --verbose flag) | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| PORT | Port used | | X | +| 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). | | | +3. [Déployez la configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). Le service apparaît dans la liste des services supervisés, et dans la page **Statut des ressources**. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros. + ## Comment puis-je tester le plugin et que signifient les options des commandes ? Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec -l'utilisateur **centreon-engine** (`su - centreon-engine`) : +l'utilisateur **centreon-engine** (`su - centreon-engine`). Vous pouvez tester +que le connecteur arrive bien à superviser une ressource en utilisant une commande +telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : ```bash -sudo /usr/lib/centreon/plugins//centreon_protocol_udp.pl \ +sudo /usr/lib/centreon/plugins/centreon_protocol_udp.pl \ --plugin=apps::protocols::udp::plugin \ --mode=connection \ --hostname='10.0.0.1' \ - --port='161' \ - + --port='161' ``` La commande devrait retourner un message de sortie similaire à : @@ -211,84 +229,86 @@ La commande devrait retourner un message de sortie similaire à : OK: Connection success on port 161 ``` +### Diagnostic des erreurs communes + +Rendez-vous sur la [documentation dédiée](../getting-started/how-to-guides/troubleshooting-plugins.md) +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 +du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est +implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce +modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal. + Tous les modes disponibles peuvent être affichés en ajoutant le paramètre `--list-mode` à la commande : ```bash -sudo /usr/lib/centreon/plugins//centreon_protocol_udp.pl \ +sudo /usr/lib/centreon/plugins/centreon_protocol_udp.pl \ --plugin=apps::protocols::udp::plugin \ - --list-mode + --list-mode ``` Le plugin apporte les modes suivants : -| Mode | Modèle de service associé | -|:-----------|:----------------------------| -| connection | App-Protocol-Udp-Connection | - - - -### Options complémentaires - +| Mode | Modèle de service associé | +|:-------------------------------------------------------------------------------------------------------------------------|:-----------------------------------| +| connection [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/protocols/udp/mode/connection.pm)] | App-Protocol-Udp-Connection-custom | +### Options disponibles #### Options des modes -Les options spécifiques aux modes sont listées ci-dessus : +Les options disponibles pour chaque modèle de services sont listées ci-dessous : -| Option | Description | Type | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------| -| --mode | Choose a mode. | Global | -| --dyn-mode | Specify a mode with the path (separated by '::'). | Global | -| --list-mode | List available modes. | Global | -| --mode-version | Check minimal version of mode. If not, unknown error. | Global | -| --version | Display plugin version. | Global | -| --pass-manager | Use a password manager. | Global | -| --verbose | Display long output. | Output | -| --debug | Display also debug messages. | Output | -| --filter-perfdata | Filter perfdata that match the regexp. | Output | -| --filter-perfdata-adv | Advanced perfdata filter. Eg: --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' | Output | -| --explode-perfdata-max | Put max perfdata (if it exist) in a specific perfdata (without values: same with '\_max' suffix) (Multiple options) | Output | -| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[m ax\]\] Common examples: Change storage free perfdata in used: --change-perfdata=free,used,invert() Change storage free perfdata in used: --change-perfdata=used,free,invert() Scale traffic values automaticaly: --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() | Output | -| --extend-perfdata-group | Extend perfdata from multiple perfdatas (methods in target are: min, max, average, sum) Syntax: --extend-perfdata-group=searchlabel,newlabel,target\[,\[newuom\],\[m in\],\[max\]\] 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)' | Output | -| --change-short-output --change-long-output | Change short/long output display: --change-short-output=pattern~replace~modifier | Output | -| --change-exit | Change exit code: --change-exit=unknown=critical | Output | -| --range-perfdata | Change perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display. | Output | -| --filter-uom | Filter UOM that match the regexp. | Output | -| --opt-exit | Optional exit code for an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc) (Default: unknown). | Output | -| --output-ignore-perfdata | Remove perfdata from output. | Output | -| --output-ignore-label | Remove label status from output. | Output | -| --output-xml | Display output in XML format. | Output | -| --output-json | Display output in JSON format. | Output | -| --output-openmetrics | Display metrics in OpenMetrics format. | Output | -| --output-file | Write output in file (can be used with json and xml options) | Output | -| --disco-format | Display discovery arguments (if the mode manages it). | Output | -| --disco-show | Display discovery values (if the mode manages it). | Output | -| --float-precision | Set the float precision for thresholds (Default: 8). | Output | -| --source-encoding | Set encoding of monitoring sources (In some case. Default: 'UTF-8'). | Output | -| --hostname | IP Addr/FQDN of the host | Mode | -| --port | Port used | Mode | -| --timeout | Connection timeout in seconds (Default: 3) | Mode | +| Option | Description | +|:-------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --hostname | IP Addr/FQDN of the host | +| --port | Port used | +| --timeout | Connection timeout in seconds (default: 3) | +| --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\[,\[\\],\[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-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 | -Pour un mode, la liste de toutes les options complémentaires et leur signification peut être +Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre `--help` à la commande : ```bash -sudo /usr/lib/centreon/plugins//centreon_protocol_udp.pl \ +sudo /usr/lib/centreon/plugins/centreon_protocol_udp.pl \ --plugin=apps::protocols::udp::plugin \ --mode=connection \ - --help -``` - -### Diagnostic des erreurs communes - -Rendez-vous sur la [documentation dédiée](../getting-started/how-to-guides/troubleshooting-plugins.md) -pour le diagnostic des erreurs communes des plugins Centreon. \ No newline at end of file + --help +``` \ No newline at end of file diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-devices-aeg-acm-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-devices-aeg-acm-snmp.md index b7a1387b632c..f844925ab6a6 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-devices-aeg-acm-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/hardware-devices-aeg-acm-snmp.md @@ -1,13 +1,13 @@ --- id: hardware-devices-aeg-acm-snmp -title: AEG ACM +title: AEG ACM 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 **AEG ACM** +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **AEG ACM SNMP** depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : * [Base Pack](./base-generic.md) @@ -15,7 +15,7 @@ depuis la page **Configuration > Connecteurs > Connecteurs de supervision** : ### Modèles -Le connecteur de supervision **AEG ACM** apporte un modèle d'hôte : +Le connecteur de supervision **AEG ACM SNMP** apporte un modèle d'hôte : * **HW-Device-Aeg-Acm-SNMP-custom** @@ -29,9 +29,9 @@ Le connecteur apporte les modèles de service suivants |:-----------------|:-----------------------------------------------|:----------------------------------------------------------| | Ac-Status | HW-Device-Aeg-Acm-Ac-Status-SNMP-custom | Contrôle de l'état de l'installation AC | | Alarm-Status | HW-Device-Aeg-Acm-Alarm-Status-SNMP-custom | Contrôle de l'état des alarmes | -| Battery-Status | HW-Device-Aeg-Acm-Battery-Status-SNMP-custom | Contrôle de l'état des batteries | +| Battery-Status | HW-Device-Aeg-Acm-Battery-Status-SNMP-custom | Contrôle de l'état des batteries | | Load-Status | HW-Device-Aeg-Acm-Load-Status-SNMP-custom | Contrôle des statistiques de l'installation de chargement | -| Rectifier-Status | HW-Device-Aeg-Acm-Rectifier-Status-SNMP-custom | Contrôle de l'état des redresseurs | +| Rectifier-Status | HW-Device-Aeg-Acm-Rectifier-Status-SNMP-custom | Contrôle de l'état des redresseurs | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **HW-Device-Aeg-Acm-SNMP-custom** est utilisé. @@ -64,7 +64,12 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et -Coming soon +| Nom | Unité | +|:----------------|:------| +| simple.status | N/A | +| simple.count | count | +| multiple.status | N/A | +| multiple.count | count | @@ -114,7 +119,8 @@ Coming soon ### Configuration SNMP -L'agent SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. +L'agent SNMP doit être activé et configuré sur l'équipement. +Veuillez vous référer à la documentation officielle du constructeur/éditeur. Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. Veillez à ce que les adresses des collecteurs Centreon y figurent bien. @@ -164,7 +170,7 @@ yum install centreon-pack-hardware-devices-aeg-acm-snmp -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **AEG ACM** +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **AEG ACM SNMP** depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. ### Plugin @@ -220,8 +226,8 @@ yum install centreon-plugin-Hardware-Devices-Aeg-Acm-Snmp > Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro **SNMPEXTRAOPTIONS**. > Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#mapping-des-options-snmpv3). -| 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. @@ -234,72 +240,72 @@ yum install centreon-plugin-Hardware-Devices-Aeg-Acm-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------:| -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /true/i'). You can use the following variables: %\{status\} | %\{status\} =~ /true/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------:| +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} =~ /true/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'alarm' | .* | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'alarm' | .* | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:-----------:| -| WARNINGAMPHOURMETER | Threshold | | | -| CRITICALAMPHOURMETER | Threshold | | | -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGCURRENT1 | Threshold | | | -| CRITICALCURRENT1 | Threshold | | | -| WARNINGCURRENT2 | Threshold | | | -| CRITICALCURRENT2 | Threshold | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /onBattery/i'). You can use the following variables: %\{status\} | %\{status\} =~ /onBattery/i | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /disconnected/i \|\| %\{status\} =~ /shutdown/i'). You can use the following variables: %\{status\} | %\{status\} =~ /disconnected/i \|\| %\{status\} =~ /shutdown/i | | -| WARNINGTEMPERATURE | Threshold | | | -| CRITICALTEMPERATURE | Threshold | | | -| WARNINGTEMPERATURE1 | Threshold | | | -| CRITICALTEMPERATURE1 | Threshold | | | -| WARNINGTEMPERATURE2 | Threshold | | | -| CRITICALTEMPERATURE2 | 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). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:-----------:| +| WARNINGAMPHOURMETER | Threshold | | | +| CRITICALAMPHOURMETER | Threshold | | | +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGCURRENT1 | Threshold | | | +| CRITICALCURRENT1 | Threshold | | | +| WARNINGCURRENT2 | Threshold | | | +| CRITICALCURRENT2 | Threshold | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | %\{status\} =~ /onBattery/i | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} =~ /disconnected/i \|\| %\{status\} =~ /shutdown/i | | +| WARNINGTEMPERATURE | Threshold | | | +| CRITICALTEMPERATURE | Threshold | | | +| WARNINGTEMPERATURE1 | Threshold | | | +| CRITICALTEMPERATURE1 | Threshold | | | +| WARNINGTEMPERATURE2 | Threshold | | | +| CRITICALTEMPERATURE2 | 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). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:----------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGPOWER | Threshold | | | -| CRITICALPOWER | Threshold | | | -| WARNINGVOLTAGE | Threshold | | | -| CRITICALVOLTAGE | Threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGPOWER | Threshold | | | +| CRITICALPOWER | 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). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|:-----------:| -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGFAULTYCOUNT | Threshold | | | -| CRITICALFAULTYCOUNT | Threshold | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /ok\|notInstalled/i'). You can use the following variables: %\{status\} | %\{status\} !~ /ok\|notInstalled/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{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). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|:-----------:| +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGFAULTYCOUNT | Threshold | | | +| CRITICALFAULTYCOUNT | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} !~ /ok\|notInstalled/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{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). | | | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md index 070014c52f73..3f3d34ee90d0 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md @@ -1,15 +1,21 @@ --- id: network-cisco-ironport-snmp -title: Cisco IronPort +title: Cisco IronPort 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 **Cisco IronPort SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles -Le connecteur de supervision **Cisco IronPort** apporte un modèle d'hôte : +Le connecteur de supervision **Cisco IronPort SNMP** apporte un modèle d'hôte : * **Net-Cisco-Ironport-SNMP-custom** @@ -22,7 +28,7 @@ Le connecteur apporte les modèles de service suivants | Alias | Modèle de service | Description | |:----------------|:-----------------------------------------------|:----------------------------------------------------| | Cpu | Net-Cisco-Ironport-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine | -| Hardware-Global | Net-Cisco-Ironport-Hardware-Global-SNMP-custom | Contrôle le matériel | +| Hardware-Global | Net-Cisco-Ironport-Hardware-Global-SNMP-custom | Contrôle le matériel (raids, alimentations) | | Memory | Net-Cisco-Ironport-Memory-SNMP-custom | Contrôle du taux d'utilisation mémoire | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Cisco-Ironport-SNMP-custom** est utilisé. @@ -34,9 +40,9 @@ Le connecteur apporte les modèles de service suivants |:---------------------|:----------------------------------------------------|:----------------------------------------------------------|:----------:| | Mail-Usage | Net-Cisco-Ironport-Mail-Usage-SNMP-custom | Contrôle l'utilisation du mail | | | Proxy-Usage | Net-Cisco-Ironport-Proxy-Usage-SNMP-custom | Contrôle l'utilisation du proxy | | -| Traffic-Generic-Id | Net-Cisco-Ironport-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Cisco-Ironport-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | -| Traffic-Global | Net-Cisco-Ironport-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | Net-Cisco-Ironport-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Cisco-Ironport-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | +| Traffic-Global | Net-Cisco-Ironport-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -49,29 +55,29 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Cisco-Ironport-SNMP-custom** host template | +| Nom de la règle | Description | +|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Cisco-Ironport-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. #### Découverte de services -| Nom de la règle | Description | -|:-------------------------------------|:------------------------------------------------------------------------| -| Net-Cisco-Ironport-SNMP-Traffic-Name | Découvre les interfaces réseaux et supervise le statut et l'utilisation | +| Nom de la règle | Description | +|:-------------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-Cisco-Ironport-SNMP-Traffic-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | +| Nom | Unité | |:----------------------------------|:------| | cpu.global.utilization.percentage | % | | cpu.proxy.utilization.percentage | % | @@ -79,12 +85,23 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -Coming soon +| Nom | Unité | +|:-----------------------------|:------| +| hardware.fan.speed.rpm | rpm | +| hardware.fan.status | N/A | +| hardware.fan.count | count | +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.raid.status | N/A | +| hardware.raid.count | count | +| hardware.temperature.celsius | C | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | -| Métrique | Unité | +| Nom | Unité | |:----------------------------------------|:------| | status | N/A | | system.queue.messages.workqueue.count | count | @@ -98,14 +115,14 @@ Coming soon -| Métrique | Unité | -|:------------|:------| -| used | % | +| Nom | Unité | +|:-----|:------| +| used | % | -| Métrique | Unité | +| Nom | Unité | |:--------------------------------------|:------| | http.response.mean.time.milliseconds | ms | | server.traffic.in.bitspersecond | b/s | @@ -121,9 +138,9 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | @@ -136,7 +153,10 @@ Coming soon ### 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 @@ -147,10 +167,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 : @@ -186,8 +204,8 @@ yum install centreon-pack-network-cisco-ironport-snmp -2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Cisco IronPort** -depuis l'interface web et le menu **Configuration > Connecteurs > Connecteurs de supervision**. +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Cisco IronPort SNMP** +depuis l'interface web et le menu **Configuration > Gestionnaire de connecteurs de supervision**. ### Plugin @@ -240,10 +258,10 @@ yum install centreon-plugin-Network-Cisco-Ironport-Snmp 3. Appliquez le modèle d'hôte **Net-Cisco-Ironport-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. @@ -256,116 +274,116 @@ yum install centreon-plugin-Network-Cisco-Ironport-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGMAIL | Thresholds | | | -| CRITICALMAIL | Thresholds | | | -| WARNINGWEBSECURITY | Thresholds | | | -| CRITICALWEBSECURITY | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGMAIL | Threshold | | | +| CRITICALMAIL | Threshold | | | +| WARNINGWEBSECURITY | Threshold | | | +| CRITICALWEBSECURITY | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'fan', 'temperature', 'psu', 'raid' | .* | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'fan', 'temperature', 'psu', 'raid' | .* | | | 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 | -|:-------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN (default: ''). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | | | -| WARNINGDNSREQUESTSOUTSTANDING | Warning threshold | | | -| CRITICALDNSREQUESTSOUTSTANDING | Warning threshold | | | -| WARNINGDNSREQUESTSPENDING | Warning threshold | | | -| CRITICALDNSREQUESTSPENDING | Warning threshold | | | -| WARNINGFDOPENED | Warning threshold | | | -| CRITICALFDOPENED | Warning threshold | | | -| WARNINGMESSAGESWORKQUEUE | Warning threshold | | | -| CRITICALMESSAGESWORKQUEUE | Warning threshold | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{resource_conservation\} =~ /memoryShortage\|queueSpaceShortage/i \|\| %\{queue_status\} =~ /queueSpaceShortage/i'). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{resource_conservation\} =~ /queueFull/i \|\| %\{queue_status\} =~ /queueFull/i'). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | | | -| WARNINGTHREADSMAIL | Warning threshold | | | -| CRITICALTHREADSMAIL | Warning threshold | | | -| WARNINGTIMEEXPIRATION | Warning threshold | | | -| CRITICALTIMEEXPIRATION | Warning threshold | | | -| WARNINGUPDATEFAILURES | Warning threshold | | | -| CRITICALUPDATEFAILURES | Warning 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 | +|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN (default: ''). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | | | +| WARNINGDNSREQUESTSOUTSTANDING | Threshold | | | +| CRITICALDNSREQUESTSOUTSTANDING | Threshold | | | +| WARNINGDNSREQUESTSPENDING | Threshold | | | +| CRITICALDNSREQUESTSPENDING | Threshold | | | +| WARNINGFDOPENED | Threshold | | | +| CRITICALFDOPENED | Threshold | | | +| WARNINGMESSAGESWORKQUEUE | Threshold | | | +| CRITICALMESSAGESWORKQUEUE | Threshold | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{resource\_conservation\} =~ /memoryShortage\|queueSpaceShortage/i \|\| %\{queue\_status\} =~ /queueSpaceShortage/i'). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{resource\_conservation\} =~ /queueFull/i \|\| %\{queue\_status\} =~ /queueFull/i'). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | | | +| WARNINGTHREADSMAIL | Threshold | | | +| CRITICALTHREADSMAIL | Threshold | | | +| WARNINGTIMEEXPIRATION | Threshold | | | +| CRITICALTIMEEXPIRATION | Threshold | | | +| WARNINGUPDATEFAILURES | Threshold | | | +| CRITICALUPDATEFAILURES | 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 | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| CRITICAL | Critical threshold in percent | 90 | | -| WARNING | Warning threshold in percent | 80 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CRITICAL | Critical threshold in percent | 90 | | +| WARNING | Warning threshold in percent | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCLIENTHTTPERRORS | Thresholds | | | -| CRITICALCLIENTHTTPERRORS | Thresholds | | | -| WARNINGCLIENTHTTPHITSRATE | Thresholds | | | -| CRITICALCLIENTHTTPHITSRATE | Thresholds | | | -| WARNINGCLIENTHTTPTRAFFICIN | Thresholds | | | -| CRITICALCLIENTHTTPTRAFFICIN | Thresholds | | | -| WARNINGCLIENTHTTPTRAFFICOUT | Thresholds | | | -| CRITICALCLIENTHTTPTRAFFICOUT | Thresholds | | | -| WARNINGCLIENTICPHITSRATE | Thresholds | | | -| CRITICALCLIENTICPHITSRATE | Thresholds | | | -| WARNINGHTTPMEANTIME | Thresholds | | | -| CRITICALHTTPMEANTIME | Thresholds | | | -| WARNINGSERVERTRAFFICIN | Thresholds | | | -| CRITICALSERVERTRAFFICIN | Thresholds | | | -| WARNINGSERVERTRAFFICOUT | Thresholds | | | -| CRITICALSERVERTRAFFICOUT | Thresholds | | | -| WARNINGTOTACONCLIENTS | Thresholds | | | -| CRITICALTOTACONCLIENTS | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCLIENTHTTPERRORS | Threshold | | | +| CRITICALCLIENTHTTPERRORS | Threshold | | | +| WARNINGCLIENTHTTPHITSRATE | Threshold | | | +| CRITICALCLIENTHTTPHITSRATE | Threshold | | | +| WARNINGCLIENTHTTPTRAFFICIN | Threshold | | | +| CRITICALCLIENTHTTPTRAFFICIN | Threshold | | | +| WARNINGCLIENTHTTPTRAFFICOUT | Threshold | | | +| CRITICALCLIENTHTTPTRAFFICOUT | Threshold | | | +| WARNINGCLIENTICPHITSRATE | Threshold | | | +| CRITICALCLIENTICPHITSRATE | Threshold | | | +| WARNINGHTTPMEANTIME | Threshold | | | +| CRITICALHTTPMEANTIME | Threshold | | | +| WARNINGSERVERTRAFFICIN | Threshold | | | +| CRITICALSERVERTRAFFICIN | Threshold | | | +| WARNINGSERVERTRAFFICOUT | Threshold | | | +| CRITICALSERVERTRAFFICOUT | Threshold | | | +| WARNINGTOTACONCLIENTS | Threshold | | | +| CRITICALTOTACONCLIENTS | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | .* | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -444,61 +462,66 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --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 | #### Options des modes @@ -507,120 +530,102 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-------------------------|:------------------------------------------------------------------| -| --warning-* --critical-* | Thresholds. Can be: 'global-utilization', 'proxy-utilization'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* --critical-* | Thresholds. Can be: 'global-utilization', 'proxy-utilization'. | -| Option | Description | -|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'fan', 'temperature', 'psu', 'raid'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu#1# | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,CRITICAL,^(?!(powerSupplyHealthy)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='fan,.*,6000' | +| Option | Description | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'fan', 'temperature', 'psu', 'raid'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu#1# | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,CRITICAL,^(?!(powerSupplyHealthy)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | +| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='fan,.*,6000' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: ''). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{resource_conservation\} =~ /memoryShortage\|queueSpaceShortage/i \|\| %\{queue_status\} =~ /queueSpaceShortage/i'). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{resource_conservation\} =~ /queueFull/i \|\| %\{queue_status\} =~ /queueFull/i'). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | -| --warning-* --critical-* | Warning threshold. Can be: 'messages-workqueue', 'dns-requests-outstanding', 'dns-requests-pending', 'fd-opened', 'threads-mail', 'update-failures', 'time-expiration'. | +| Option | Description | +|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: ''). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{resource\_conservation\} =~ /memoryShortage\|queueSpaceShortage/i \|\| %\{queue\_status\} =~ /queueSpaceShortage/i'). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{resource\_conservation\} =~ /queueFull/i \|\| %\{queue\_status\} =~ /queueFull/i'). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | +| --warning-* --critical-* | Warning threshold. Can be: 'messages-workqueue', 'dns-requests-outstanding', 'dns-requests-pending', 'fd-opened', 'threads-mail', 'update-failures', 'time-expiration'. | -| Option | Description | -|:-----------|:----------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. | +| Option | Description | +|:-----------|:------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | -| Option | Description | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='http' | -| --warning-* --critical-* | Thresholds. Can be: 'client-http-hits-rate', 'client-http-errors', 'client-http-traffic-in', 'client-http-traffic-out', 'client-http-requests', 'total-con-clients', 'client-icp-hits-rate', 'server-traffic-in', 'server-traffic-out', 'http-mean-time'. | +| Option | Description | +|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='http' | +| --warning-* --critical-* | Thresholds. Can be: 'client-http-hits-rate', 'client-http-errors', 'client-http-traffic-in', 'client-http-traffic-out', 'client-http-requests', 'total-con-clients', 'client-icp-hits-rate', 'server-traffic-in', 'server-traffic-out', 'http-mean-time'. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-perle-ids-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-perle-ids-snmp.md index 9a42601180f5..4cad6b066955 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-perle-ids-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-perle-ids-snmp.md @@ -5,6 +5,12 @@ title: Perle IDS 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 **Perle IDS SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles @@ -23,7 +29,7 @@ Le connecteur apporte les modèles de service suivants |:----------------|:------------------------------------------|:-----------------------------------------| | Alarms | Net-Perle-Ids-Alarms-SNMP-custom | Contrôle les alarmes | | Hardware-Global | Net-Perle-Ids-Hardware-Global-SNMP-custom | Contrôle le matériel | -| System-Usage | Net-Perle-Ids-System-Usage-SNMP-custom | Contrôle l'utilisation CPU et la mémoire | +| System-Usage | Net-Perle-Ids-System-Usage-SNMP-custom | Contrôle l'utilisation cpu et la mémoire | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Perle-Ids-SNMP-custom** est utilisé. @@ -43,36 +49,42 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Perle-Ids-SNMP-custom** | +| Nom de la règle | Description | +|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Perle-Ids-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | -|:------------|:------| -| status | N/A | +| Nom | Unité | +|:-------|:------| +| status | N/A | > Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. -Coming soon +| Nom | Unité | +|:-----------------------------|:------| +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | -| Métrique | Unité | +| Nom | Unité | |:----------------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | | *interface_name*#interface.packets.in.discard.percentage | % | @@ -83,7 +95,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:---------------------------|:------| | cpu.utilization.percentage | % | | memory.free.bytes | B | @@ -96,7 +108,10 @@ Coming soon ### Configuration SNMP -L'agent 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 @@ -107,10 +122,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 : @@ -147,7 +160,7 @@ yum install centreon-pack-network-perle-ids-snmp 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Perle IDS 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 @@ -200,10 +213,10 @@ yum install centreon-plugin-Network-Perle-Ids-Snmp 3. Appliquez le modèle d'hôte **Net-Perle-Ids-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,84 +229,84 @@ yum install centreon-plugin-Network-Perle-Ids-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| -| FILTERMSG | Filter by message (can be a regexp) | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{severity\} =~ /minor/i') You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | %\{severity\} =~ /minor/i | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{severity\} =~ /critical\|major/i'). You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | %\{severity\} =~ /critical\|major/i | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:-----------:| +| FILTERMSG | Filter by message (can be a regexp) | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | %\{severity\} =~ /minor/i | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | %\{severity\} =~ /critical\|major/i | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'temperature', 'psu' | .* | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'temperature', 'psu' | .* | | | 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 | -|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| -| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINBCAST | Thresholds | | | -| CRITICALINBCAST | Thresholds | | | -| WARNINGINDISCARD | Thresholds | | | -| CRITICALINDISCARD | Thresholds | | | -| WARNINGINERROR | Thresholds | | | -| CRITICALINERROR | Thresholds | | | -| WARNINGINMCAST | Thresholds | | | -| CRITICALINMCAST | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGINUCAST | Thresholds | | | -| CRITICALINUCAST | Thresholds | | | -| WARNINGINVOLUME | Thresholds | | | -| CRITICALINVOLUME | Thresholds | | | -| WARNINGOUTBCAST | Thresholds | | | -| CRITICALOUTBCAST | Thresholds | | | -| WARNINGOUTDISCARD | Thresholds | | | -| CRITICALOUTDISCARD | Thresholds | | | -| WARNINGOUTERROR | Thresholds | | | -| CRITICALOUTERROR | Thresholds | | | -| WARNINGOUTMCAST | Thresholds | | | -| CRITICALOUTMCAST | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | -| WARNINGOUTUCAST | Thresholds | | | -| CRITICALOUTUCAST | Thresholds | | | -| WARNINGOUTVOLUME | Thresholds | | | -| CRITICALOUTVOLUME | Thresholds | | | -| WARNINGSPEED | Thresholds | | | -| CRITICALSPEED | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| WARNINGTOTALADMINDOWN | Thresholds | | | -| CRITICALTOTALADMINDOWN | Thresholds | | | -| WARNINGTOTALADMINUP | Thresholds | | | -| CRITICALTOTALADMINUP | Thresholds | | | -| WARNINGTOTALOPERDOWN | Thresholds | | | -| CRITICALTOTALOPERDOWN | Thresholds | | | -| WARNINGTOTALOPERUP | Thresholds | | | -| CRITICALTOTALOPERUP | Thresholds | | | -| WARNINGTOTALPORT | Thresholds | | | -| CRITICALTOTALPORT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose --no-skipped-counters | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| +| OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINBCAST | Threshold | | | +| CRITICALINBCAST | Threshold | | | +| WARNINGINDISCARD | Threshold | | | +| CRITICALINDISCARD | Threshold | | | +| WARNINGINERROR | Threshold | | | +| CRITICALINERROR | Threshold | | | +| WARNINGINMCAST | Threshold | | | +| CRITICALINMCAST | Threshold | | | +| WARNINGINTRAFFIC | Threshold | | | +| CRITICALINTRAFFIC | Threshold | | | +| WARNINGINUCAST | Threshold | | | +| CRITICALINUCAST | Threshold | | | +| WARNINGINVOLUME | Threshold | | | +| CRITICALINVOLUME | Threshold | | | +| WARNINGOUTBCAST | Threshold | | | +| CRITICALOUTBCAST | Threshold | | | +| WARNINGOUTDISCARD | Threshold | | | +| CRITICALOUTDISCARD | Threshold | | | +| WARNINGOUTERROR | Threshold | | | +| CRITICALOUTERROR | Threshold | | | +| WARNINGOUTMCAST | Threshold | | | +| CRITICALOUTMCAST | Threshold | | | +| WARNINGOUTTRAFFIC | Threshold | | | +| CRITICALOUTTRAFFIC | Threshold | | | +| WARNINGOUTUCAST | Threshold | | | +| CRITICALOUTUCAST | Threshold | | | +| WARNINGOUTVOLUME | Threshold | | | +| CRITICALOUTVOLUME | Threshold | | | +| WARNINGSPEED | Threshold | | | +| CRITICALSPEED | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| WARNINGTOTALADMINDOWN | Threshold | | | +| CRITICALTOTALADMINDOWN | Threshold | | | +| WARNINGTOTALADMINUP | Threshold | | | +| CRITICALTOTALADMINUP | Threshold | | | +| WARNINGTOTALOPERDOWN | Threshold | | | +| CRITICALTOTALOPERDOWN | Threshold | | | +| WARNINGTOTALOPERUP | Threshold | | | +| CRITICALTOTALOPERUP | Threshold | | | +| WARNINGTOTALPORT | Threshold | | | +| CRITICALTOTALPORT | 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 --no-skipped-counters | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:----------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCPULOAD | Thresholds | | | -| CRITICALCPULOAD | Thresholds | | | -| WARNINGFLASHDISKFREE | Thresholds | | | -| CRITICALFLASHDISKFREE | Thresholds | | | -| WARNINGMEMORYFREE | Thresholds | | | -| CRITICALMEMORYFREE | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCPULOAD | Threshold | | | +| CRITICALCPULOAD | Threshold | | | +| WARNINGFLASHDISKFREE | Threshold | | | +| CRITICALFLASHDISKFREE | Threshold | | | +| WARNINGMEMORYFREE | Threshold | | | +| CRITICALMEMORYFREE | 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). | | | @@ -321,7 +334,7 @@ telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) : --warning-memory-free='' \ --critical-memory-free='' \ --warning-flashdisk-free='' \ - --critical-flashdisk-free='' + --critical-flashdisk-free='' ``` La commande devrait retourner un message de sortie similaire à : @@ -337,7 +350,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. @@ -367,61 +380,66 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --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 | #### Options des modes @@ -430,95 +448,97 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-msg | Filter by message (can be a regexp). | -| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{severity\} =~ /minor/i') You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{severity\} =~ /critical\|major/i'). You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | -| --memory | Only check new alarms. | +| Option | Description | +|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --filter-msg | Filter by message (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{severity\} =~ /minor/i') You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{severity\} =~ /critical\|major/i'). You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | +| --memory | Only check new alarms. | -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'temperature', 'psu'. | -| --add-name-instance | Add literal description for instance value (used in filter, absent-problem and threshold options). | -| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=psu,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu,1 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,CRITICAL,^(?!(normal\|initial)$)' | -| --warning | Set warning threshold for 'temperature' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | -| --critical | Set critical threshold for 'temperature' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | +| Option | Description | +|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'temperature', 'psu'. | +| --add-name-instance | Add literal description for instance value (used in filter, absent-problem and threshold options). | +| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=psu,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu,1 | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,CRITICAL,^(?!(normal\|initial)$)' | +| --warning | Set warning threshold for 'temperature' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | +| --critical | Set critical threshold for 'temperature' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (givenin option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory-free$' | -| --warning-* --critical-* | Thresholds. Can be: 'memory-free' (B), 'cpu-load' (%), 'flashdisk-free' (B) | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory-free$' | +| --warning-* --critical-* | Thresholds. Can be: 'memory-free' (B), 'cpu-load' (%), 'flashdisk-free' (B) | diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-watchguard-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-watchguard-snmp.md index f391343d7a21..369bcef499f5 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-watchguard-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-watchguard-snmp.md @@ -1,15 +1,21 @@ --- id: network-watchguard-snmp -title: Watchguard +title: Watchguard 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 **Watchguard SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) + ## Contenu du pack ### Modèles -Le connecteur de supervision **Watchguard** apporte un modèle d'hôte : +Le connecteur de supervision **Watchguard SNMP** apporte un modèle d'hôte : * **Net-Watchguard-SNMP-custom** @@ -23,20 +29,20 @@ Le connecteur apporte les modèles de service suivants |:---------|:------------------------------------|:----------------------------------------------------| | Cpu | Net-Watchguard-Cpu-SNMP-custom | Contrôle du taux d'utilisation du CPU de la machine | | Hardware | Net-Watchguard-Hardware-SNMP-custom | Contrôle l'état du matériel | -| System | Net-Watchguard-System-SNMP-custom | Contrôle les statistiques système | +| System | Net-Watchguard-System-SNMP-custom | Contrôle les statistiques systèmes | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Watchguard-SNMP-custom** est utilisé. -| Alias | Modèle de service | Description | Découverte | -|:---------------|:------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------|:----------:| -| Cluster | Net-Watchguard-Cluster-SNMP-custom | Contrôle l'état du cluster | | -| Disk-Global | Net-Watchguard-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques | X | -| Ipsec-Tunnel | Net-Watchguard-Ipsec-Tunnel-SNMP-custom | Contrôle les tunnels IPsec | | -| Policy-Usage | Net-Watchguard-Policy-Usage-SNMP-custom | Contrôle les 'policy' | | -| Traffic-Global | Net-Watchguard-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | +| Alias | Modèle de service | Description | Découverte | +|:---------------|:------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------|:----------:| +| Cluster | Net-Watchguard-Cluster-SNMP-custom | Contrôle l'état du cluster | | +| Disk-Global | Net-Watchguard-Disk-Global-SNMP-custom | Contrôle du taux d'espace libre disponible des disques. Pour chaque contrôle apparaîtra le point de montage des disques| X | +| Ipsec-Tunnel | Net-Watchguard-Ipsec-Tunnel-SNMP-custom | Contrôle les tunnels ipsec | | +| Policy-Usage | Net-Watchguard-Policy-Usage-SNMP-custom | Contrôle les 'policy' | | +| Traffic-Global | Net-Watchguard-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -49,41 +55,41 @@ Le connecteur apporte les modèles de service suivants #### Découverte d'hôtes -| Nom de la règle | Description | -|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Watchguard-SNMP-custom** host template | +| Nom de la règle | Description | +|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Découvre les ressources via un scan réseau SNMP. Installez le connecteur [Generic SNMP](./applications-protocol-snmp.md) pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte **Net-Watchguard-SNMP-custom**. | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. #### Découverte de services -| Nom de la règle | Description | -|:----------------------------------|:------------------------------------------------------------------------| -| Net-Watchguard-SNMP-Storages-Name | Discover the disk partitions and monitor space occupation | -| Net-Watchguard-SNMP-Traffic-Name | Découvre les interfaces réseau et supervise le statut et l'utilisation | +| Nom de la règle | Description | +|:----------------------------------|:--------------------------------------------------------------------------------------------------| +| Net-Watchguard-SNMP-Storages-Name | Découvre les partitions du disque en utilisant son nom et supervise l'espace occupé | +| Net-Watchguard-SNMP-Traffic-Name | Découvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation | Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/services-discovery) pour en savoir plus sur la découverte automatique de services et sa [planification](/docs/monitoring/discovery/services-discovery/#règles-de-découverte). ### Métriques & statuts collectés -Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. +Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service. -| Métrique | Unité | +| Nom | Unité | |:--------------------------------------------|:------| | cluster-status | N/A | | members.detected.count | count | -| *members*#member-status | N/A | +| member-status | N/A | | *members*#member.health.hardware.percentage | % | | *members*#member.health.system.percentage | % | -| Métrique | Unité | +| Nom | Unité | |:-------------------------------|:------| | cpu.utilization.1m.percentage | % | | cpu.utilization.5m.percentage | % | @@ -94,7 +100,7 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -| Métrique | Unité | +| Nom | Unité | |:--------------------------------------|:------| | storage.partitions.count | count | | *disk_name*#storage.space.usage.bytes | B | @@ -105,12 +111,19 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques rat -Coming soon +| Nom | Unité | +|:------------------------|:------| +| hardware.port.status | N/A | +| hardware.port.count | count | +| hardware.sensors.status | N/A | +| hardware.sensors.count | count | +| hardware.unit.status | N/A | +| hardware.unit.count | count | -| Métrique | Unité | +| Nom | Unité | |:------------------------------------------------|:------| | ipsec.tunnels.total.count | count | | *tunnel*#ipsec.tunnel.traffic.in.bitspersecond | b/s | @@ -119,7 +132,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:------------------------------------------|:------| | *policy*#policy.connections.current.count | count | | *policy*#policy.connections.total.count | count | @@ -131,7 +144,7 @@ Coming soon -| Métrique | Unité | +| Nom | Unité | |:---------------------------------|:------| | system.connections.current.count | count | | system.traffic.in.bitspersecond | b/s | @@ -142,11 +155,14 @@ Coming soon -| Métrique | Unité | -|:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | +| Nom | Unité | +|:------------------------------------------------------|:------| +| status | N/A | +| status | N/A | +| *interface_name1*#interface.traffic.in.bitspersecond | b/s | +| *interface_name2*#interface.traffic.in.bitspersecond | b/s | +| *interface_name1*#interface.traffic.out.bitspersecond | b/s | +| *interface_name2*#interface.traffic.out.bitspersecond | b/s | @@ -155,7 +171,10 @@ Coming soon ### 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 @@ -166,10 +185,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 : @@ -206,7 +223,7 @@ yum install centreon-pack-network-watchguard-snmp 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Watchguard** -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 @@ -259,10 +276,10 @@ yum install centreon-plugin-Network-Watchguard-Snmp 3. Appliquez le modèle d'hôte **Net-Watchguard-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. @@ -275,108 +292,108 @@ yum install centreon-plugin-Network-Watchguard-Snmp -| Macro | Description | Valeur par défaut | Obligatoire | -|:-----------------------------|:----------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCLUSTERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\} | | | -| CRITICALCLUSTERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\} | | | -| WARNINGMEMBERHEALTHHARDWARE | Thresholds | | | -| CRITICALMEMBERHEALTHHARDWARE | Thresholds | | | -| WARNINGMEMBERHEALTHSYSTEM | Thresholds | | | -| CRITICALMEMBERHEALTHSYSTEM | Thresholds | | | -| WARNINGMEMBERSDETECTED | Thresholds | | | -| CRITICALMEMBERSDETECTED | Thresholds | | | -| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{serial\} | | | -| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{serial\} | | | -| 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 | +|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCLUSTERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\} | | | +| CRITICALCLUSTERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\} | | | +| WARNINGMEMBERHEALTHHARDWARE | Threshold | | | +| CRITICALMEMBERHEALTHHARDWARE | Threshold | | | +| WARNINGMEMBERHEALTHSYSTEM | Threshold | | | +| CRITICALMEMBERHEALTHSYSTEM | Threshold | | | +| WARNINGMEMBERSDETECTED | Threshold | | | +| CRITICALMEMBERSDETECTED | Threshold | | | +| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{serial\} | | | +| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{serial\} | | | +| 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 | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING15MIN | Warning threshold | | | -| CRITICAL15MIN | Warning threshold | | | -| WARNING1MIN | Warning threshold | | | -| CRITICAL1MIN | Warning threshold | | | -| WARNING5MIN | Warning threshold | | | -| CRITICAL5MIN | Warning threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING15MIN | Threshold | | | +| CRITICAL15MIN | Threshold | | | +| WARNING1MIN | Threshold | | | +| CRITICAL1MIN | Threshold | | | +| WARNING5MIN | Threshold | | | +| CRITICAL5MIN | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | -| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| WARNING | Warning threshold | 80 | | -| CRITICAL | Critical threshold | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | +| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| WARNING | Warning threshold | 80 | | +| CRITICAL | Critical threshold | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'device' | .* | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check (default: '.*'). Can be: 'device' | .* | | | 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 name (can be a regexp) | | | -| WARNINGTUNNELSTOTAL | Thresholds | | | -| CRITICALTUNNELSTOTAL | Thresholds | | | -| WARNINGTUNNELTRAFFICIN | Thresholds | | | -| CRITICALTUNNELTRAFFICIN | Thresholds | | | -| WARNINGTUNNELTRAFFICOUT | Thresholds | | | -| CRITICALTUNNELTRAFFICOUT | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERNAME | Filter name (can be a regexp) | | | +| WARNINGTUNNELSTOTAL | Threshold | | | +| CRITICALTUNNELSTOTAL | Threshold | | | +| WARNINGTUNNELTRAFFICIN | Threshold | | | +| CRITICALTUNNELTRAFFICIN | Threshold | | | +| WARNINGTUNNELTRAFFICOUT | Threshold | | | +| CRITICALTUNNELTRAFFICOUT | 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 policy name (can be a regexp) | | | -| WARNINGCURRENTCONNECTIONS | Warning threshold | | | -| CRITICALCURRENTCONNECTIONS | Critical threshold | | | -| WARNINGL2TRAFFIC | Warning threshold | | | -| CRITICALL2TRAFFIC | Critical threshold | | | -| WARNINGL3TRAFFIC | Warning threshold | | | -| CRITICALL3TRAFFIC | Critical threshold | | | -| WARNINGTOTALCONNECTIONS | Warning threshold | | | -| CRITICALTOTALCONNECTIONS | Critical threshold | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERNAME | Filter policy name (can be a regexp) | | | +| WARNINGCURRENTCONNECTIONS | Threshold | | | +| CRITICALCURRENTCONNECTIONS | Threshold | | | +| WARNINGL2TRAFFIC | Threshold | | | +| CRITICALL2TRAFFIC | Threshold | | | +| WARNINGL3TRAFFIC | Threshold | | | +| CRITICALL3TRAFFIC | Threshold | | | +| WARNINGTOTALCONNECTIONS | Threshold | | | +| CRITICALTOTALCONNECTIONS | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:--------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCONNECTIONS | Thresholds | | | -| CRITICALCONNECTIONS | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCONNECTIONS | Threshold | | | +| CRITICALCONNECTIONS | Threshold | | | +| WARNINGINTRAFFIC | Threshold | | | +| CRITICALINTRAFFIC | Threshold | | | +| WARNINGOUTTRAFFIC | Threshold | | | +| CRITICALOUTTRAFFIC | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | | | -| Macro | Description | Valeur par défaut | Obligatoire | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | .* | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | +| Macro | Description | Valeur par défaut | Obligatoire | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| WARNINGIN | Threshold | 80 | | +| CRITICALIN | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | @@ -463,61 +480,66 @@ Le plugin apporte les modes suivants : Les options génériques sont listées ci-dessous : -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --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 | #### Options des modes @@ -526,182 +548,155 @@ Les options disponibles pour chaque modèle de services sont listées ci-dessous -| Option | Description | -|:--------------------------|:------------------------------------------------------------------------------------------------------------------------| -| --unknown-cluster-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{state\} | -| --warning-cluster-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\} | -| --critical-cluster-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\} | -| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{serial\} | -| --warning-member-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{serial\} | -| --critical-member-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{serial\} | -| --warning-* --critical-* | Thresholds. Can be: 'members-detected', 'member-health-hardware', 'member-health-system'. | +| Option | Description | +|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --unknown-cluster-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{state\} | +| --warning-cluster-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\} | +| --critical-cluster-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\} | +| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{serial\} | +| --warning-member-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{serial\} | +| --critical-member-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{serial\} | +| --warning-* --critical-* | Thresholds. Can be: 'members-detected', 'member-health-hardware', 'member-health-system'. | -| Option | Description | -|:-------------------------|:---------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^1min\|5min$' | -| --warning-* --critical-* | Warning threshold. Can be: '1min', '5min', '15min'. | +| Option | Description | +|:-------------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^1min\|5min$' | +| --warning-* --critical-* | Warning threshold. Can be: '1min', '5min', '15min'. | -| Option | Description | -|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --warning-access | Warning threshold. | -| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | -| --add-access | Check storage access (readOnly, readWrite). | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | -| --name | Allows to use storage name with option --storage instead ofstorage oid index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --path-best-match | Allows to select best path mount point (with --name). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache storage data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --filter-duplicate | Filter duplicate storages (in used size and total size). | -| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | +| Option | Description | +|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'device'. | -| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=device,network.* | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='device.network,OK,down' | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'device'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=device,network.* | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='device.network,OK,down' | +| --warning | Define the warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | +| --critical | Define the critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). package snmp\_standard::mode::components::device; use strict; use warnings; use centreon::plugins::misc; my %map\_status = (1 =\> 'unknown', 2 =\> 'running', 3 =\> 'warning', 4 =\> 'testing', 5 =\> 'down'); my %map\_type = ( '.1.3.6.1.2.1.25.3.1.1' =\> 'other', '.1.3.6.1.2.1.25.3.1.2' =\> 'unknown', '.1.3.6.1.2.1.25.3.1.3' =\> 'processor', '.1.3.6.1.2.1.25.3.1.4' =\> 'network', '.1.3.6.1.2.1.25.3.1.5' =\> 'printer', '.1.3.6.1.2.1.25.3.1.6' =\> 'diskStorage', '.1.3.6.1.2.1.25.3.1.10', =\> 'video', '.1.3.6.1.2.1.25.3.1.11' =\> 'audio', '.1.3.6.1.2.1.25.3.1.12' =\> 'coprocessor', '.1.3.6.1.2.1.25.3.1.13' =\> 'keyboard', '.1.3.6.1.2.1.25.3.1.14' =\> 'modem', '.1.3.6.1.2.1.25.3.1.15' =\> 'parallelPort', '.1.3.6.1.2.1.25.3.1.16' =\> 'pointing', '.1.3.6.1.2.1.25.3.1.17' =\> 'serialPort', '.1.3.6.1.2.1.25.3.1.18' =\> 'tape', '.1.3.6.1.2.1.25.3.1.19' =\> 'clock', '.1.3.6.1.2.1.25.3.1.20' =\> 'volatileMemory', '.1.3.6.1.2.1.25.3.1.21' =\> 'nonVolatileMemory', ); my $mapping = \{ hrDeviceType =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.2', map =\> \%map\_type \}, hrDeviceDescr =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.3' \}, hrDeviceStatus =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.5', map =\> \%map\_status \}, \}; my $oid\_hrDeviceEntry = '.1.3.6.1.2.1.25.3.2.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_hrDeviceEntry \}; \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> "Checking devices"); $self-\>\{components\}-\>\{device\} = \{name =\> 'devices', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'device')); foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_hrDeviceEntry\}\})) \{ next if ($oid !~ /^$mapping-\>\{hrDeviceStatus\}-\>\{oid\}\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_hrDeviceEntry\}, instance =\> $instance); next if ($self-\>check\_filter(section =\> 'device', instance =\> $result-\>\{hrDeviceType\} . '.' . $instance)); $result-\>\{hrDeviceDescr\} = centreon::plugins::misc::trim($result-\>\{hrDeviceDescr\}); $self-\>\{components\}-\>\{device\}-\>\{total\}++; $self-\>\{output\}-\>output\_add(long\_msg =\> sprintf("device '%s' status is '%s' \[instance = %s\]", $result-\>\{hrDeviceDescr\}, $result-\>\{hrDeviceStatus\}, $result-\>\{hrDeviceType\} . '.' . $instance)); my $exit = $self-\>get\_severity(label =\> 'default', section =\> 'device.' . $result-\>\{hrDeviceType\}, value =\> $result-\>\{hrDeviceStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add(severity =\> $exit, short\_msg =\> sprintf("Device '%s' status is '%s'", $result-\>\{hrDeviceDescr\}, $result-\>\{hrDeviceStatus\})); \} \} \} 1; | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-name | Filter name (can be a regexp). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='tunnels-total' | -| --warning-* --critical-* | Thresholds. Can be: 'tunnels-total', 'tunnel-traffic-in', 'tunnel-traffic-out'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='tunnels-total' | +| --filter-name | Filter name (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'tunnels-total', 'tunnel-traffic-in', 'tunnel-traffic-out'. | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-connections$' | -| --filter-name | Filter policy name (can be a regexp). | -| --warning-* | Warning threshold. Can be: 'total-connections', 'current-connections' 'l3-traffic' (b/s), 'l2-traffic' (b/s). | -| --critical-* | Critical threshold. Can be: 'total-connections', 'current-connections' 'l3-traffic' (b/s), 'l2-traffic' (b/s). | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-connections$' | +| --filter-name | Filter policy name (can be a regexp). | +| --warning-* | Warning threshold. Can be: 'total-connections', 'current-connections' 'l3-traffic' (b/s), 'l2-traffic' (b/s). | +| --critical-* | Critical threshold. Can be: 'total-connections', 'current-connections' 'l3-traffic' (b/s), 'l2-traffic' (b/s). | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^connections$' | -| --warning-* --critical-* | Thresholds. Can be: 'in-traffic', 'out-traffic', 'connections'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^connections$' | +| --warning-* --critical-* | Thresholds. Can be: 'in-traffic', 'out-traffic', 'connections'. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | diff --git a/pp/integrations/plugin-packs/procedures/applications-protocol-udp.md b/pp/integrations/plugin-packs/procedures/applications-protocol-udp.md index 91ea38866f84..8a8a0d5bb6c9 100644 --- a/pp/integrations/plugin-packs/procedures/applications-protocol-udp.md +++ b/pp/integrations/plugin-packs/procedures/applications-protocol-udp.md @@ -5,61 +5,73 @@ title: Protocol UDP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -## Pack Assets +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Protocol UDP** connector through the +**Configuration > Connectors > Monitoring Connectors** menu: +* [Base Pack](./base-generic.md) + +## Pack assets ### Templates The Monitoring Connector **Protocol UDP** brings 2 host templates: -* App-Protocol-Udp -* App-Protocol-Udp-Only +* **App-Protocol-Udp-custom** +* **App-Protocol-Udp-Only-custom** -The connector brings the following service template (sorted by host template): +The connector brings the following service templates (sorted by the host template they are attached to): - + -| Service Alias | Service Template | Service Description | -|:--------------|:------------------|:--------------------| -| N/A | N/A | N/A | +This host template does not bring any service template. - + -| Service Alias | Service Template | Service Description | -|:--------------|:------------------|:--------------------| -| N/A | N/A | N/A | +This host template does not bring any service template. - + -| Service Alias | Service Template | Service Description | -|:--------------|:----------------------------|:--------------------------| -| Connection | App-Protocol-Udp-Connection | Check UDP port connection | +| Service Alias | Service Template | Service Description | +|:--------------|:-----------------------------------|:--------------------------| +| Connection | App-Protocol-Udp-Connection-custom | Check UDP port connection | -> These services are not automatically created when the host template is applied. +> The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. - - ### Collected metrics & status +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. + -Coming soon +| Name | Unit | +|:-------|:-----| +| status | N/A | -## Setup +## Prerequisites -### Monitoring Pack +The SNMP agent must be enabled and configured on the resource. Please refer to the official documentation from the manufacturer/publisher. +Your resource may require a list of addresses authorized to query it to be set up. +Please ensure that the addresses of the Centreon pollers are included in this list. -If the platform uses an *online* license, you can skip the package installation -instruction below as it is not required to have the pack displayed within the +## Installing the monitoring connector + +### 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. 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: @@ -95,7 +107,7 @@ yum install centreon-pack-applications-protocol-udp -Whatever the license type (*online* or *offline*), install the **Protocol UDP** Pack through +2. Whatever the license type (*online* or *offline*), install the **Protocol UDP** connector through the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -112,97 +124,102 @@ You still have to manually install the plugin on the poller(s) when: Use the commands below according to your operating system's package manager: - + ```bash dnf install centreon-plugin-Applications-Protocol-Udp ``` - + ```bash dnf install centreon-plugin-Applications-Protocol-Udp ``` - + ```bash -yum install centreon-plugin-Applications-Protocol-Udp +apt install centreon-plugin-applications-protocol-udp ``` - + ```bash -apt install centreon-plugin-applications-protocol-udp +yum install centreon-plugin-Applications-Protocol-Udp ``` -## Configuration +## Using the monitoring connector -### Host +### Using a host template provided by the connector - + 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. -3. Apply the **App-Protocol-Udp-custom** template to the host. +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. +3. Apply the **App-Protocol-Udp-custom** template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior. + +| Macro | Description | Default value | Mandatory | +|:-----------|:--------------|:--------------|:---------:| +| UDPPORT | Port used | 161 | X | +| UDPTIMEOUT | Timeout value | 3 | | -| Mandatory | Macro | Description | Default | -|:------------|:-----------|:------------|:--------| -| | UDPPORT | | 161 | -| | UDPTIMEOUT | | 3 | +5. [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. - + 1. Log into Centreon and add a new host through **Configuration > Hosts**. -2. Fill the **Name**, **Alias** & **IP Address/DNS** fields according to your ressource settings. -3. Apply the **App-Protocol-Udp-Only-custom** template to the host. -4. Once the template is applied, fill in the corresponding macros. Some macros are mandatory. +2. Fill in the **Name**, **Alias** & **IP Address/DNS** fields according to your resource's settings. +3. Apply the **App-Protocol-Udp-Only-custom** template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior. +4. Fill in the macros you want. Some macros are mandatory. + +| Macro | Description | Default value | Mandatory | +|:-----------|:--------------|:--------------|:---------:| +| UDPPORT | Port used | 161 | X | +| UDPTIMEOUT | Timeout value | 3 | | -| Mandatory | Macro | Description | Default | -|:------------|:-----------|:------------|:--------| -| | UDPPORT | | 161 | -| | UDPTIMEOUT | | 3 | +5. [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. +### Using a service template provided by the connector -### Service - -Once the template is applied, fill in the corresponding macros. Some macros are mandatory. +1. If you have used a host template and checked **Create Services linked to the Template too**, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, [create manually the services you want](/docs/monitoring/basic-objects/services) and apply a service template to them. +2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below). -| Mandatory | Macro | Description | Default | -|:------------|:-------------|:--------------------------------------------------------------------------------|:--------| -| | PORT | Port used | | -| | EXTRAOPTIONS | Any extra option you may want to add to the command line (eg. a --verbose flag) | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|:---------:| +| PORT | Port used | | X | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +3. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). The service appears in the list of services, and on the **Resources Status** page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros. + ## 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`) and test the plugin by -running the following command: +**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 -sudo /usr/lib/centreon/plugins//centreon_protocol_udp.pl \ +sudo /usr/lib/centreon/plugins/centreon_protocol_udp.pl \ --plugin=apps::protocols::udp::plugin \ --mode=connection \ --hostname='10.0.0.1' \ - --port='161' \ - + --port='161' ``` The expected command output is shown below: @@ -211,69 +228,76 @@ The expected command output is shown below: OK: Connection success on port 161 ``` +### Troubleshooting + +Please find the [troubleshooting documentation](../getting-started/how-to-guides/troubleshooting-plugins.md) +for Centreon Plugins typical issues. + ### Available modes +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 +connector in your terminal. + All available modes can be displayed by adding the `--list-mode` parameter to the command: ```bash -sudo /usr/lib/centreon/plugins//centreon_protocol_udp.pl \ +sudo /usr/lib/centreon/plugins/centreon_protocol_udp.pl \ --plugin=apps::protocols::udp::plugin \ - --list-mode + --list-mode ``` The plugin brings the following modes: -| Mode | Linked service template | -|:-----------|:----------------------------| -| connection | App-Protocol-Udp-Connection | - - +| Mode | Linked service template | +|:-------------------------------------------------------------------------------------------------------------------------|:-----------------------------------| +| connection [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/apps/protocols/udp/mode/connection.pm)] | App-Protocol-Udp-Connection-custom | ### Available options - - #### Modes options -All modes specific options are listed here: +All available options for each service template are listed below: -| Option | Description | Type | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------| -| --mode | Choose a mode. | Global | -| --dyn-mode | Specify a mode with the path (separated by '::'). | Global | -| --list-mode | List available modes. | Global | -| --mode-version | Check minimal version of mode. If not, unknown error. | Global | -| --version | Display plugin version. | Global | -| --pass-manager | Use a password manager. | Global | -| --verbose | Display long output. | Output | -| --debug | Display also debug messages. | Output | -| --filter-perfdata | Filter perfdata that match the regexp. | Output | -| --filter-perfdata-adv | Advanced perfdata filter. Eg: --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' | Output | -| --explode-perfdata-max | Put max perfdata (if it exist) in a specific perfdata (without values: same with '\_max' suffix) (Multiple options) | Output | -| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[m ax\]\] Common examples: Change storage free perfdata in used: --change-perfdata=free,used,invert() Change storage free perfdata in used: --change-perfdata=used,free,invert() Scale traffic values automaticaly: --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() | Output | -| --extend-perfdata-group | Extend perfdata from multiple perfdatas (methods in target are: min, max, average, sum) Syntax: --extend-perfdata-group=searchlabel,newlabel,target\[,\[newuom\],\[m in\],\[max\]\] 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)' | Output | -| --change-short-output --change-long-output | Change short/long output display: --change-short-output=pattern~replace~modifier | Output | -| --change-exit | Change exit code: --change-exit=unknown=critical | Output | -| --range-perfdata | Change perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display. | Output | -| --filter-uom | Filter UOM that match the regexp. | Output | -| --opt-exit | Optional exit code for an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc) (Default: unknown). | Output | -| --output-ignore-perfdata | Remove perfdata from output. | Output | -| --output-ignore-label | Remove label status from output. | Output | -| --output-xml | Display output in XML format. | Output | -| --output-json | Display output in JSON format. | Output | -| --output-openmetrics | Display metrics in OpenMetrics format. | Output | -| --output-file | Write output in file (can be used with json and xml options) | Output | -| --disco-format | Display discovery arguments (if the mode manages it). | Output | -| --disco-show | Display discovery values (if the mode manages it). | Output | -| --float-precision | Set the float precision for thresholds (Default: 8). | Output | -| --source-encoding | Set encoding of monitoring sources (In some case. Default: 'UTF-8'). | Output | -| --hostname | IP Addr/FQDN of the host | Mode | -| --port | Port used | Mode | -| --timeout | Connection timeout in seconds (Default: 3) | Mode | +| Option | Description | +|:-------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --hostname | IP Addr/FQDN of the host | +| --port | Port used | +| --timeout | Connection timeout in seconds (default: 3) | +| --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\[,\[\\],\[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-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 | @@ -282,13 +306,8 @@ All available options for a given mode can be displayed by adding the `--help` parameter to the command: ```bash -sudo /usr/lib/centreon/plugins//centreon_protocol_udp.pl \ +sudo /usr/lib/centreon/plugins/centreon_protocol_udp.pl \ --plugin=apps::protocols::udp::plugin \ --mode=connection \ - --help -``` - -### Troubleshooting - -Please find the [troubleshooting documentation](../getting-started/how-to-guides/troubleshooting-plugins.md) -for Centreon Plugins typical issues. \ No newline at end of file + --help +``` \ No newline at end of file diff --git a/pp/integrations/plugin-packs/procedures/hardware-devices-aeg-acm-snmp.md b/pp/integrations/plugin-packs/procedures/hardware-devices-aeg-acm-snmp.md index 1d80f7575fbb..8be0113e933e 100644 --- a/pp/integrations/plugin-packs/procedures/hardware-devices-aeg-acm-snmp.md +++ b/pp/integrations/plugin-packs/procedures/hardware-devices-aeg-acm-snmp.md @@ -1,13 +1,13 @@ --- id: hardware-devices-aeg-acm-snmp -title: AEG ACM +title: AEG ACM SNMP --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ## Connector dependencies -The following monitoring connectors will be installed when you install the **AEG ACM** connector through the +The following monitoring connectors will be installed when you install the **AEG ACM SNMP** connector through the **Configuration > Connectors > Monitoring Connectors** menu: * [Base Pack](./base-generic.md) @@ -15,7 +15,7 @@ The following monitoring connectors will be installed when you install the **AEG ### Templates -The Monitoring Connector **AEG ACM** brings a host template: +The Monitoring Connector **AEG ACM SNMP** brings a host template: * **HW-Device-Aeg-Acm-SNMP-custom** @@ -24,13 +24,13 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | -|:-----------------|:-----------------------------------------------|:----------------------------| -| Ac-Status | HW-Device-Aeg-Acm-Ac-Status-SNMP-custom | Check AC plant status | -| Alarm-Status | HW-Device-Aeg-Acm-Alarm-Status-SNMP-custom | Check the status of alarms | -| Battery-Status | HW-Device-Aeg-Acm-Battery-Status-SNMP-custom | Check battery status | -| Load-Status | HW-Device-Aeg-Acm-Load-Status-SNMP-custom | Check load plant statistics | -| Rectifier-Status | HW-Device-Aeg-Acm-Rectifier-Status-SNMP-custom | Check the status of rectifiers | +| Service Alias | Service Template | Service Description | +|:-----------------|:-----------------------------------------------|:-------------------------------| +| Ac-Status | HW-Device-Aeg-Acm-Ac-Status-SNMP-custom | Check AC plant status | +| Alarm-Status | HW-Device-Aeg-Acm-Alarm-Status-SNMP-custom | Check the status of alarms | +| Battery-Status | HW-Device-Aeg-Acm-Battery-Status-SNMP-custom | Check battery status | +| Load-Status | HW-Device-Aeg-Acm-Load-Status-SNMP-custom | Check load plant statistics | +| Rectifier-Status | HW-Device-Aeg-Acm-Rectifier-Status-SNMP-custom | Check the status of rectifiers | > The services listed above are created automatically when the **HW-Device-Aeg-Acm-SNMP-custom** host template is used. @@ -63,7 +63,12 @@ Here is the list of services for this connector, detailing all metrics and statu -Coming soon +| Name | Unit | +|:----------------|:------| +| simple.status | N/A | +| simple.count | count | +| multiple.status | N/A | +| multiple.count | count | @@ -113,7 +118,8 @@ Coming soon ### SNMP Configuration -The SNMP agent must be enabled and configured on the resource. Please refer to the official documentation from the manufacturer/publisher. +The SNMP agent must be enabled and configured on the resource. +Please refer to the official documentation from the manufacturer/publisher. Your resource may require a list of addresses authorized to query it to be set up. Please ensure that the addresses of the Centreon pollers are included in this list. @@ -163,7 +169,7 @@ yum install centreon-pack-hardware-devices-aeg-acm-snmp -2. Whatever the license type (*online* or *offline*), install the **AEG ACM** connector through +2. Whatever the license type (*online* or *offline*), install the **AEG ACM SNMP** connector through the **Configuration > Connectors > Monitoring Connectors** menu. ### Plugin @@ -221,8 +227,8 @@ yum install centreon-plugin-Hardware-Devices-Aeg-Acm-Snmp > When using SNMP v3, use the **SNMPEXTRAOPTIONS** macro to add specific authentication parameters. > More information in the [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. -| Macro | Description | Default value | Mandatory | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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. @@ -235,72 +241,72 @@ yum install centreon-plugin-Hardware-Devices-Aeg-Acm-Snmp -| Macro | Description | Default value | Mandatory | -|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------:| -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /true/i'). You can use the following variables: %\{status\} | %\{status\} =~ /true/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{status\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------:| +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} =~ /true/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'alarm' | .* | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'alarm' | .* | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:-----------:| -| WARNINGAMPHOURMETER | Threshold | | | -| CRITICALAMPHOURMETER | Threshold | | | -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGCURRENT1 | Threshold | | | -| CRITICALCURRENT1 | Threshold | | | -| WARNINGCURRENT2 | Threshold | | | -| CRITICALCURRENT2 | Threshold | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{status\} =~ /onBattery/i'). You can use the following variables: %\{status\} | %\{status\} =~ /onBattery/i | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} =~ /disconnected/i \|\| %\{status\} =~ /shutdown/i'). You can use the following variables: %\{status\} | %\{status\} =~ /disconnected/i \|\| %\{status\} =~ /shutdown/i | | -| WARNINGTEMPERATURE | Threshold | | | -| CRITICALTEMPERATURE | Threshold | | | -| WARNINGTEMPERATURE1 | Threshold | | | -| CRITICALTEMPERATURE1 | Threshold | | | -| WARNINGTEMPERATURE2 | Threshold | | | -| CRITICALTEMPERATURE2 | 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). | | | +| Macro | Description | Default value | Mandatory | +|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:-----------:| +| WARNINGAMPHOURMETER | Threshold | | | +| CRITICALAMPHOURMETER | Threshold | | | +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGCURRENT1 | Threshold | | | +| CRITICALCURRENT1 | Threshold | | | +| WARNINGCURRENT2 | Threshold | | | +| CRITICALCURRENT2 | Threshold | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{status\} | %\{status\} =~ /onBattery/i | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} =~ /disconnected/i \|\| %\{status\} =~ /shutdown/i | | +| WARNINGTEMPERATURE | Threshold | | | +| CRITICALTEMPERATURE | Threshold | | | +| WARNINGTEMPERATURE1 | Threshold | | | +| CRITICALTEMPERATURE1 | Threshold | | | +| WARNINGTEMPERATURE2 | Threshold | | | +| CRITICALTEMPERATURE2 | 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). | | | -| Macro | Description | Default value | Mandatory | -|:----------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGPOWER | Threshold | | | -| CRITICALPOWER | Threshold | | | -| WARNINGVOLTAGE | Threshold | | | -| CRITICALVOLTAGE | Threshold | | | +| Macro | Description | Default value | Mandatory | +|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGPOWER | Threshold | | | +| CRITICALPOWER | 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). | | | -| Macro | Description | Default value | Mandatory | -|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|:-----------:| -| WARNINGCURRENT | Threshold | | | -| CRITICALCURRENT | Threshold | | | -| WARNINGFAULTYCOUNT | Threshold | | | -| CRITICALFAULTYCOUNT | Threshold | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{status\} !~ /ok\|notInstalled/i'). You can use the following variables: %\{status\} | %\{status\} !~ /ok\|notInstalled/i | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: ''). You can use the following variables: %\{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). | | | +| Macro | Description | Default value | Mandatory | +|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|:-----------:| +| WARNINGCURRENT | Threshold | | | +| CRITICALCURRENT | Threshold | | | +| WARNINGFAULTYCOUNT | Threshold | | | +| CRITICALFAULTYCOUNT | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{status\} | %\{status\} !~ /ok\|notInstalled/i | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{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). | | | diff --git a/pp/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md b/pp/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md index dd8c234a89c7..ddf146c6967d 100644 --- a/pp/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md @@ -1,15 +1,21 @@ --- id: network-cisco-ironport-snmp -title: Cisco IronPort +title: Cisco IronPort SNMP --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Cisco IronPort SNMP** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates -The Monitoring Connector **Cisco IronPort** brings a host template: +The Monitoring Connector **Cisco IronPort SNMP** brings a host template: * **Net-Cisco-Ironport-SNMP-custom** @@ -21,7 +27,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:----------------|:-----------------------------------------------|:-----------------------------------------------------| | Cpu | Net-Cisco-Ironport-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine | -| Hardware-Global | Net-Cisco-Ironport-Hardware-Global-SNMP-custom | Check hardware | +| Hardware-Global | Net-Cisco-Ironport-Hardware-Global-SNMP-custom | Check hardware (raids, power supplies) | | Memory | Net-Cisco-Ironport-Memory-SNMP-custom | Check memory usage | > The services listed above are created automatically when the **Net-Cisco-Ironport-SNMP-custom** host template is used. @@ -29,13 +35,13 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:---------------------|:----------------------------------------------------|:---------------------------------------------|:----------:| -| Mail-Usage | Net-Cisco-Ironport-Mail-Usage-SNMP-custom | Check email usage | | -| Proxy-Usage | Net-Cisco-Ironport-Proxy-Usage-SNMP-custom | Check proxy usage | | -| Traffic-Generic-Id | Net-Cisco-Ironport-Traffic-Generic-Id-SNMP-custom | Check traffic of a network interface | | -| Traffic-Generic-Name | Net-Cisco-Ironport-Traffic-Generic-Name-SNMP-custom | Check traffic of a network interface | | -| Traffic-Global | Net-Cisco-Ironport-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | +| Service Alias | Service Template | Service Description | Discovery | +|:---------------------|:----------------------------------------------------|:---------------------------------------------|:---------:| +| Mail-Usage | Net-Cisco-Ironport-Mail-Usage-SNMP-custom | Check email security usage | | +| Proxy-Usage | Net-Cisco-Ironport-Proxy-Usage-SNMP-custom | Check proxy usage | | +| Traffic-Generic-Id | Net-Cisco-Ironport-Traffic-Generic-Id-SNMP-custom | Check traffic of an network interface | | +| Traffic-Generic-Name | Net-Cisco-Ironport-Traffic-Generic-Name-SNMP-custom | Check traffic of an network interface | | +| Traffic-Global | Net-Cisco-Ironport-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -48,9 +54,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Cisco-Ironport-SNMP-custom** host template | +| Rule name | Description | +|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Cisco-Ironport-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -65,12 +71,12 @@ and in the [following chapter](/docs/monitoring/discovery/services-discovery/#di ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | +| Name | Unit | |:----------------------------------|:------| | cpu.global.utilization.percentage | % | | cpu.proxy.utilization.percentage | % | @@ -78,12 +84,23 @@ Here is the list of services for this connector, detailing all metrics linked to -Coming soon +| Name | Unit | +|:-----------------------------|:------| +| hardware.fan.speed.rpm | rpm | +| hardware.fan.status | N/A | +| hardware.fan.count | count | +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.raid.status | N/A | +| hardware.raid.count | count | +| hardware.temperature.celsius | C | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | -| Metric name | Unit | +| Name | Unit | |:----------------------------------------|:------| | status | N/A | | system.queue.messages.workqueue.count | count | @@ -97,14 +114,14 @@ Coming soon -| Metric name | Unit | -|:------------|:------| -| used | % | +| Name | Unit | +|:-----|:------| +| used | % | -| Metric name | Unit | +| Name | Unit | |:--------------------------------------|:------| | http.response.mean.time.milliseconds | ms | | server.traffic.in.bitspersecond | b/s | @@ -120,9 +137,9 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | @@ -146,12 +163,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: @@ -170,7 +184,7 @@ dnf install centreon-pack-network-cisco-ironport-snmp ``` - + ```bash apt install centreon-pack-network-cisco-ironport-snmp @@ -186,8 +200,8 @@ yum install centreon-pack-network-cisco-ironport-snmp -2. Whatever the license type (*online* or *offline*), install the **Cisco IronPort** connector through -the **Configuration > Connectors > Monitoring Connectors** menu. +2. Whatever the license type (*online* or *offline*), install the **Cisco IronPort SNMP** connector through +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -217,7 +231,7 @@ dnf install centreon-plugin-Network-Cisco-Ironport-Snmp ``` - + ```bash apt install centreon-plugin-network-cisco-ironport-snmp @@ -244,8 +258,8 @@ yum install centreon-plugin-Network-Cisco-Ironport-Snmp > When using SNMP v3, use the **SNMPEXTRAOPTIONS** macro to add specific authentication parameters. > More information in the [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. -| Macro | Description | Default value | Mandatory | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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. @@ -258,116 +272,116 @@ yum install centreon-plugin-Network-Cisco-Ironport-Snmp -| Macro | Description | Default value | Mandatory | -|:--------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGMAIL | Thresholds | | | -| CRITICALMAIL | Thresholds | | | -| WARNINGWEBSECURITY | Thresholds | | | -| CRITICALWEBSECURITY | Thresholds | | | +| Macro | Description | Default value | Mandatory | +|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGMAIL | Threshold | | | +| CRITICALMAIL | Threshold | | | +| WARNINGWEBSECURITY | Threshold | | | +| CRITICALWEBSECURITY | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'fan', 'temperature', 'psu', 'raid' | .* | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'fan', 'temperature', 'psu', 'raid' | .* | | | 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 | -|:-------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN (default: ''). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | | | -| WARNINGDNSREQUESTSOUTSTANDING | Warning threshold | | | -| CRITICALDNSREQUESTSOUTSTANDING | Warning threshold | | | -| WARNINGDNSREQUESTSPENDING | Warning threshold | | | -| CRITICALDNSREQUESTSPENDING | Warning threshold | | | -| WARNINGFDOPENED | Warning threshold | | | -| CRITICALFDOPENED | Warning threshold | | | -| WARNINGMESSAGESWORKQUEUE | Warning threshold | | | -| CRITICALMESSAGESWORKQUEUE | Warning threshold | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{resource_conservation\} =~ /memoryShortage\|queueSpaceShortage/i \|\| %\{queue_status\} =~ /queueSpaceShortage/i'). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{resource_conservation\} =~ /queueFull/i \|\| %\{queue_status\} =~ /queueFull/i'). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | | | -| WARNINGTHREADSMAIL | Warning threshold | | | -| CRITICALTHREADSMAIL | Warning threshold | | | -| WARNINGTIMEEXPIRATION | Warning threshold | | | -| CRITICALTIMEEXPIRATION | Warning threshold | | | -| WARNINGUPDATEFAILURES | Warning threshold | | | -| CRITICALUPDATEFAILURES | Warning 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 | +|:-------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| UNKNOWNSTATUS | Define the conditions to match for the status to be UNKNOWN (default: ''). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | | | +| WARNINGDNSREQUESTSOUTSTANDING | Threshold | | | +| CRITICALDNSREQUESTSOUTSTANDING | Threshold | | | +| WARNINGDNSREQUESTSPENDING | Threshold | | | +| CRITICALDNSREQUESTSPENDING | Threshold | | | +| WARNINGFDOPENED | Threshold | | | +| CRITICALFDOPENED | Threshold | | | +| WARNINGMESSAGESWORKQUEUE | Threshold | | | +| CRITICALMESSAGESWORKQUEUE | Threshold | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{resource\_conservation\} =~ /memoryShortage\|queueSpaceShortage/i \|\| %\{queue\_status\} =~ /queueSpaceShortage/i'). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{resource\_conservation\} =~ /queueFull/i \|\| %\{queue\_status\} =~ /queueFull/i'). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | | | +| WARNINGTHREADSMAIL | Threshold | | | +| CRITICALTHREADSMAIL | Threshold | | | +| WARNINGTIMEEXPIRATION | Threshold | | | +| CRITICALTIMEEXPIRATION | Threshold | | | +| WARNINGUPDATEFAILURES | Threshold | | | +| CRITICALUPDATEFAILURES | 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 | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| CRITICAL | Critical threshold in percent | 90 | | -| WARNING | Warning threshold in percent | 80 | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| CRITICAL | Critical threshold in percent | 90 | | +| WARNING | Warning threshold in percent | 80 | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-----------------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCLIENTHTTPERRORS | Thresholds | | | -| CRITICALCLIENTHTTPERRORS | Thresholds | | | -| WARNINGCLIENTHTTPHITSRATE | Thresholds | | | -| CRITICALCLIENTHTTPHITSRATE | Thresholds | | | -| WARNINGCLIENTHTTPTRAFFICIN | Thresholds | | | -| CRITICALCLIENTHTTPTRAFFICIN | Thresholds | | | -| WARNINGCLIENTHTTPTRAFFICOUT | Thresholds | | | -| CRITICALCLIENTHTTPTRAFFICOUT | Thresholds | | | -| WARNINGCLIENTICPHITSRATE | Thresholds | | | -| CRITICALCLIENTICPHITSRATE | Thresholds | | | -| WARNINGHTTPMEANTIME | Thresholds | | | -| CRITICALHTTPMEANTIME | Thresholds | | | -| WARNINGSERVERTRAFFICIN | Thresholds | | | -| CRITICALSERVERTRAFFICIN | Thresholds | | | -| WARNINGSERVERTRAFFICOUT | Thresholds | | | -| CRITICALSERVERTRAFFICOUT | Thresholds | | | -| WARNINGTOTACONCLIENTS | Thresholds | | | -| CRITICALTOTACONCLIENTS | Thresholds | | | +| Macro | Description | Default value | Mandatory | +|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCLIENTHTTPERRORS | Threshold | | | +| CRITICALCLIENTHTTPERRORS | Threshold | | | +| WARNINGCLIENTHTTPHITSRATE | Threshold | | | +| CRITICALCLIENTHTTPHITSRATE | Threshold | | | +| WARNINGCLIENTHTTPTRAFFICIN | Threshold | | | +| CRITICALCLIENTHTTPTRAFFICIN | Threshold | | | +| WARNINGCLIENTHTTPTRAFFICOUT | Threshold | | | +| CRITICALCLIENTHTTPTRAFFICOUT | Threshold | | | +| WARNINGCLIENTICPHITSRATE | Threshold | | | +| CRITICALCLIENTICPHITSRATE | Threshold | | | +| WARNINGHTTPMEANTIME | Threshold | | | +| CRITICALHTTPMEANTIME | Threshold | | | +| WARNINGSERVERTRAFFICIN | Threshold | | | +| CRITICALSERVERTRAFFICIN | Threshold | | | +| WARNINGSERVERTRAFFICOUT | Threshold | | | +| CRITICALSERVERTRAFFICOUT | Threshold | | | +| WARNINGTOTACONCLIENTS | Threshold | | | +| CRITICALTOTACONCLIENTS | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACEID | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:-------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACEID | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| INTERFACENAME | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | .* | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| CRITICALIN | Threshold | 90 | | +| WARNINGIN | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -444,61 +458,66 @@ The plugin brings the following modes: All generic options are listed here: -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --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 | #### Modes options @@ -507,120 +526,102 @@ All available options for each service template are listed below: -| Option | Description | -|:-------------------------|:------------------------------------------------------------------| -| --warning-* --critical-* | Thresholds. Can be: 'global-utilization', 'proxy-utilization'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --warning-* --critical-* | Thresholds. Can be: 'global-utilization', 'proxy-utilization'. | -| Option | Description | -|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'fan', 'temperature', 'psu', 'raid'. | -| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu#1# | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,CRITICAL,^(?!(powerSupplyHealthy)$)' | -| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | -| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='fan,.*,6000' | +| Option | Description | +|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'fan', 'temperature', 'psu', 'raid'. | +| --filter | Exclude the items given as a comma-separated list (example: --filter=fan --filter=temperature). You can also exclude items from specific instances: --filter=fan,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu#1# | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,CRITICAL,^(?!(powerSupplyHealthy)$)' | +| --warning | Set warning threshold for temperatures (syntax: type,regexp,threshold) Example: --warning='temperature,.*,30' | +| --critical | Set critical threshold for temperatures (syntax: type,regexp,threshold) Example: --critical='fan,.*,6000' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). | -| Option | Description | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: ''). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | -| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{resource_conservation\} =~ /memoryShortage\|queueSpaceShortage/i \|\| %\{queue_status\} =~ /queueSpaceShortage/i'). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{resource_conservation\} =~ /queueFull/i \|\| %\{queue_status\} =~ /queueFull/i'). You can use the following variables: %\{queue_status\}, %\{resource_conservation\} | -| --warning-* --critical-* | Warning threshold. Can be: 'messages-workqueue', 'dns-requests-outstanding', 'dns-requests-pending', 'fd-opened', 'threads-mail', 'update-failures', 'time-expiration'. | +| Option | Description | +|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN (default: ''). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | +| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{resource\_conservation\} =~ /memoryShortage\|queueSpaceShortage/i \|\| %\{queue\_status\} =~ /queueSpaceShortage/i'). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{resource\_conservation\} =~ /queueFull/i \|\| %\{queue\_status\} =~ /queueFull/i'). You can use the following variables: %\{queue\_status\}, %\{resource\_conservation\} | +| --warning-* --critical-* | Warning threshold. Can be: 'messages-workqueue', 'dns-requests-outstanding', 'dns-requests-pending', 'fd-opened', 'threads-mail', 'update-failures', 'time-expiration'. | -| Option | Description | -|:-----------|:----------------------------------| -| --warning | Warning threshold in percent. | -| --critical | Critical threshold in percent. | +| Option | Description | +|:-----------|:------------------------------------| +| --warning | Warning threshold in percent. | +| --critical | Critical threshold in percent. | -| Option | Description | -|:-------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='http' | -| --warning-* --critical-* | Thresholds. Can be: 'client-http-hits-rate', 'client-http-errors', 'client-http-traffic-in', 'client-http-traffic-out', 'client-http-requests', 'total-con-clients', 'client-icp-hits-rate', 'server-traffic-in', 'server-traffic-out', 'http-mean-time'. | +| Option | Description | +|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='http' | +| --warning-* --critical-* | Thresholds. Can be: 'client-http-hits-rate', 'client-http-errors', 'client-http-traffic-in', 'client-http-traffic-out', 'client-http-requests', 'total-con-clients', 'client-icp-hits-rate', 'server-traffic-in', 'server-traffic-out', 'http-mean-time'. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | diff --git a/pp/integrations/plugin-packs/procedures/network-perle-ids-snmp.md b/pp/integrations/plugin-packs/procedures/network-perle-ids-snmp.md index 811e322f7537..9370a2531763 100644 --- a/pp/integrations/plugin-packs/procedures/network-perle-ids-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-perle-ids-snmp.md @@ -5,6 +5,12 @@ title: Perle IDS SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Perle IDS SNMP** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates @@ -22,7 +28,7 @@ The connector brings the following service templates (sorted by the host templat |:----------------|:------------------------------------------|:---------------------------| | Alarms | Net-Perle-Ids-Alarms-SNMP-custom | Check alarms | | Hardware-Global | Net-Perle-Ids-Hardware-Global-SNMP-custom | Check hardware | -| System-Usage | Net-Perle-Ids-System-Usage-SNMP-custom | Check CPU and memory usage | +| System-Usage | Net-Perle-Ids-System-Usage-SNMP-custom | Check cpu and memory usage | > The services listed above are created automatically when the **Net-Perle-Ids-SNMP-custom** host template is used. @@ -42,36 +48,42 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Perle-Ids-SNMP-custom** host template | +| Rule name | Description | +|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Perle-Ids-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). ### Collected metrics & status -Here is the list of services for this connector, detailing all metrics linked to each service. +Here is the list of services for this connector, detailing all metrics and statuses linked to each service. -| Metric name | Unit | -|:------------|:------| -| status | N/A | +| Name | Unit | +|:-------|:------| +| status | N/A | > To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. -Coming soon +| Name | Unit | +|:-----------------------------|:------| +| hardware.psu.status | N/A | +| hardware.psu.count | count | +| hardware.temperature.status | N/A | +| hardware.temperature.count | count | +| hardware.temperature.celsius | C | -| Metric name | Unit | +| Name | Unit | |:----------------------------------------------------------|:------| -| *interface_name*#status | N/A | +| status | N/A | | *interface_name*#interface.traffic.in.bitspersecond | b/s | | *interface_name*#interface.traffic.out.bitspersecond | b/s | | *interface_name*#interface.packets.in.discard.percentage | % | @@ -82,7 +94,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:---------------------------|:------| | cpu.utilization.percentage | % | | memory.free.bytes | B | @@ -95,7 +107,10 @@ Coming soon ### SNMP Configuration -The SNMP agent 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 @@ -106,12 +121,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: @@ -147,7 +159,7 @@ yum install centreon-pack-network-perle-ids-snmp 2. Whatever the license type (*online* or *offline*), install the **Perle IDS SNMP** connector through -the **Configuration > Connectors > Monitoring Connectors** menu. +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -199,13 +211,13 @@ yum install centreon-plugin-Network-Perle-Ids-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 **Net-Perle-Ids-SNMP-custom** template to the host. +3. Apply the **Net-Perle-Ids-SNMP-custom** template to the host. > When using SNMP v3, use the **SNMPEXTRAOPTIONS** macro to add specific authentication parameters. > More information in the [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. -| Macro | Description | Default value | Mandatory | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| Macro | Description | Default value | Mandatory | +|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| | SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | 4. [Deploy the configuration](/docs/monitoring/monitoring-servers/deploying-a-configuration). The host appears in the list of hosts, and on the **Resources Status** page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros. @@ -218,84 +230,84 @@ yum install centreon-plugin-Network-Perle-Ids-Snmp -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------|:-----------:| -| FILTERMSG | Filter by message (can be a regexp) | | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING (default: '%\{severity\} =~ /minor/i') You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | %\{severity\} =~ /minor/i | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{severity\} =~ /critical\|major/i'). You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | %\{severity\} =~ /critical\|major/i | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:---------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------|:-----------:| +| FILTERMSG | Filter by message (can be a regexp) | | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING . You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | %\{severity\} =~ /minor/i | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | %\{severity\} =~ /critical\|major/i | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'temperature', 'psu' | .* | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check. Can be: 'temperature', 'psu' | .* | | | 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 | -|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| -| OIDFILTER | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| OIDDISPLAY | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | -| INTERFACENAME | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | -| WARNINGINBCAST | Thresholds | | | -| CRITICALINBCAST | Thresholds | | | -| WARNINGINDISCARD | Thresholds | | | -| CRITICALINDISCARD | Thresholds | | | -| WARNINGINERROR | Thresholds | | | -| CRITICALINERROR | Thresholds | | | -| WARNINGINMCAST | Thresholds | | | -| CRITICALINMCAST | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGINUCAST | Thresholds | | | -| CRITICALINUCAST | Thresholds | | | -| WARNINGINVOLUME | Thresholds | | | -| CRITICALINVOLUME | Thresholds | | | -| WARNINGOUTBCAST | Thresholds | | | -| CRITICALOUTBCAST | Thresholds | | | -| WARNINGOUTDISCARD | Thresholds | | | -| CRITICALOUTDISCARD | Thresholds | | | -| WARNINGOUTERROR | Thresholds | | | -| CRITICALOUTERROR | Thresholds | | | -| WARNINGOUTMCAST | Thresholds | | | -| CRITICALOUTMCAST | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | -| WARNINGOUTUCAST | Thresholds | | | -| CRITICALOUTUCAST | Thresholds | | | -| WARNINGOUTVOLUME | Thresholds | | | -| CRITICALOUTVOLUME | Thresholds | | | -| WARNINGSPEED | Thresholds | | | -| CRITICALSPEED | Thresholds | | | -| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | -| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| WARNINGTOTALADMINDOWN | Thresholds | | | -| CRITICALTOTALADMINDOWN | Thresholds | | | -| WARNINGTOTALADMINUP | Thresholds | | | -| CRITICALTOTALADMINUP | Thresholds | | | -| WARNINGTOTALOPERDOWN | Thresholds | | | -| CRITICALTOTALOPERDOWN | Thresholds | | | -| WARNINGTOTALOPERUP | Thresholds | | | -| CRITICALTOTALOPERUP | Thresholds | | | -| WARNINGTOTALPORT | Thresholds | | | -| CRITICALTOTALPORT | Thresholds | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose --no-skipped-counters | | +| Macro | Description | Default value | Mandatory | +|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-----------:| +| OIDFILTER | Define the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| OIDDISPLAY | Define the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr) | ifname | | +| INTERFACENAME | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | | | +| WARNINGINBCAST | Threshold | | | +| CRITICALINBCAST | Threshold | | | +| WARNINGINDISCARD | Threshold | | | +| CRITICALINDISCARD | Threshold | | | +| WARNINGINERROR | Threshold | | | +| CRITICALINERROR | Threshold | | | +| WARNINGINMCAST | Threshold | | | +| CRITICALINMCAST | Threshold | | | +| WARNINGINTRAFFIC | Threshold | | | +| CRITICALINTRAFFIC | Threshold | | | +| WARNINGINUCAST | Threshold | | | +| CRITICALINUCAST | Threshold | | | +| WARNINGINVOLUME | Threshold | | | +| CRITICALINVOLUME | Threshold | | | +| WARNINGOUTBCAST | Threshold | | | +| CRITICALOUTBCAST | Threshold | | | +| WARNINGOUTDISCARD | Threshold | | | +| CRITICALOUTDISCARD | Threshold | | | +| WARNINGOUTERROR | Threshold | | | +| CRITICALOUTERROR | Threshold | | | +| WARNINGOUTMCAST | Threshold | | | +| CRITICALOUTMCAST | Threshold | | | +| WARNINGOUTTRAFFIC | Threshold | | | +| CRITICALOUTTRAFFIC | Threshold | | | +| WARNINGOUTUCAST | Threshold | | | +| CRITICALOUTUCAST | Threshold | | | +| WARNINGOUTVOLUME | Threshold | | | +| CRITICALOUTVOLUME | Threshold | | | +| WARNINGSPEED | Threshold | | | +| CRITICALSPEED | Threshold | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | %\{admstatus\} eq "up" and %\{opstatus\} !~ /up\|dormant/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | +| WARNINGTOTALADMINDOWN | Threshold | | | +| CRITICALTOTALADMINDOWN | Threshold | | | +| WARNINGTOTALADMINUP | Threshold | | | +| CRITICALTOTALADMINUP | Threshold | | | +| WARNINGTOTALOPERDOWN | Threshold | | | +| CRITICALTOTALOPERDOWN | Threshold | | | +| WARNINGTOTALOPERUP | Threshold | | | +| CRITICALTOTALOPERUP | Threshold | | | +| WARNINGTOTALPORT | Threshold | | | +| CRITICALTOTALPORT | 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 --no-skipped-counters | | -| Macro | Description | Default value | Mandatory | -|:----------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCPULOAD | Thresholds | | | -| CRITICALCPULOAD | Thresholds | | | -| WARNINGFLASHDISKFREE | Thresholds | | | -| CRITICALFLASHDISKFREE | Thresholds | | | -| WARNINGMEMORYFREE | Thresholds | | | -| CRITICALMEMORYFREE | Thresholds | | | +| Macro | Description | Default value | Mandatory | +|:----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCPULOAD | Threshold | | | +| CRITICALCPULOAD | Threshold | | | +| WARNINGFLASHDISKFREE | Threshold | | | +| CRITICALFLASHDISKFREE | Threshold | | | +| WARNINGMEMORYFREE | Threshold | | | +| CRITICALMEMORYFREE | 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). | | | @@ -306,7 +318,7 @@ yum install centreon-plugin-Network-Perle-Ids-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 @@ -321,7 +333,7 @@ is able to monitor a resource using a command like this one (replace the sample --warning-memory-free='' \ --critical-memory-free='' \ --warning-flashdisk-free='' \ - --critical-flashdisk-free='' + --critical-flashdisk-free='' ``` The expected command output is shown below: @@ -339,7 +351,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 @@ -367,61 +379,66 @@ The plugin brings the following modes: All generic options are listed here: -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --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 | #### Modes options @@ -430,95 +447,97 @@ All available options for each service template are listed below: -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-msg | Filter by message (can be a regexp). | -| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{severity\} =~ /minor/i') You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{severity\} =~ /critical\|major/i'). You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | -| --memory | Only check new alarms. | +| Option | Description | +|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --filter-msg | Filter by message (can be a regexp). | +| --warning-status | Define the conditions to match for the status to be WARNING (default: '%\{severity\} =~ /minor/i') You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{severity\} =~ /critical\|major/i'). You can use the following variables: %\{severity\}, %\{text\}, %\{source\}, %\{since\} | +| --memory | Only check new alarms. | -| Option | Description | -|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'temperature', 'psu'. | -| --add-name-instance | Add literal description for instance value (used in filter, absent-problem and threshold options). | -| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=psu,1 | -| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu,1 | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,CRITICAL,^(?!(normal\|initial)$)' | -| --warning | Set warning threshold for 'temperature' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | -| --critical | Set critical threshold for 'temperature' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | +| Option | Description | +|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'temperature', 'psu'. | +| --add-name-instance | Add literal description for instance value (used in filter, absent-problem and threshold options). | +| --filter | Exclude the items given as a comma-separated list (example: --filter=psu). You can also exclude items from specific instances: --filter=psu,1 | +| --absent-problem | Return an error if an entity is not 'present' (default is skipping) (comma separated list) Can be specific or global: --absent-problem=psu,1 | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='psu,CRITICAL,^(?!(normal\|initial)$)' | +| --warning | Set warning threshold for 'temperature' (syntax: type,regexp,threshold) Example: --warning='temperature,.*,40' | +| --critical | Set critical threshold for 'temperature' (syntax: type,regexp,threshold) Example: --critical='temperature,.*,50' | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Fall back on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | -| --interface | Define the interface filter on IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | -| --name | With this option, the interfaces will be filtered by name (givenin option --interface) instead of OID index. The name matching mode supports regular expressions. | -| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory-free$' | -| --warning-* --critical-* | Thresholds. Can be: 'memory-free' (B), 'cpu-load' (%), 'flashdisk-free' (B) | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^memory-free$' | +| --warning-* --critical-* | Thresholds. Can be: 'memory-free' (B), 'cpu-load' (%), 'flashdisk-free' (B) | diff --git a/pp/integrations/plugin-packs/procedures/network-watchguard-snmp.md b/pp/integrations/plugin-packs/procedures/network-watchguard-snmp.md index 512951471597..4d6e7e4ba30f 100644 --- a/pp/integrations/plugin-packs/procedures/network-watchguard-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-watchguard-snmp.md @@ -1,15 +1,21 @@ --- id: network-watchguard-snmp -title: Watchguard +title: Watchguard SNMP --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies + +The following monitoring connectors will be installed when you install the **Watchguard SNMP** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) + ## Pack assets ### Templates -The Monitoring Connector **Watchguard** brings a host template: +The Monitoring Connector **Watchguard SNMP** brings a host template: * **Net-Watchguard-SNMP-custom** @@ -21,7 +27,7 @@ The connector brings the following service templates (sorted by the host templat | Service Alias | Service Template | Service Description | |:--------------|:------------------------------------|:-----------------------------------------------------| | Cpu | Net-Watchguard-Cpu-SNMP-custom | Check the rate of utilization of CPU for the machine | -| Hardware | Net-Watchguard-Hardware-SNMP-custom | Check the state of the hardware | +| Hardware | Net-Watchguard-Hardware-SNMP-custom | Check hardware environment | | System | Net-Watchguard-System-SNMP-custom | Check system statistics | > The services listed above are created automatically when the **Net-Watchguard-SNMP-custom** host template is used. @@ -29,13 +35,13 @@ The connector brings the following service templates (sorted by the host templat -| Service Alias | Service Template | Service Description | Discovery | -|:---------------|:------------------------------------------|:---------------------------------------------------------------------------------------------|:----------:| -| Cluster | Net-Watchguard-Cluster-SNMP-custom | Check cluster | | -| Disk-Global | Net-Watchguard-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each check the mount point of disks will appear | X | -| Ipsec-Tunnel | Net-Watchguard-Ipsec-Tunnel-SNMP-custom | Check IPsec tunnels | | -| Policy-Usage | Net-Watchguard-Policy-Usage-SNMP-custom | Check policy usage | | -| Traffic-Global | Net-Watchguard-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | +| Service Alias | Service Template | Service Description | Discovery | +|:---------------|:------------------------------------------|:--------------------------------------------------------------------------------------------|:---------:| +| Cluster | Net-Watchguard-Cluster-SNMP-custom | Check cluster | | +| Disk-Global | Net-Watchguard-Disk-Global-SNMP-custom | Check the rate of free space on disks. For each checks the mount point of disks will appear | X | +| Ipsec-Tunnel | Net-Watchguard-Ipsec-Tunnel-SNMP-custom | Check ipsec tunnels | | +| Policy-Usage | Net-Watchguard-Policy-Usage-SNMP-custom | Check policy usage | | +| Traffic-Global | Net-Watchguard-Traffic-Global-SNMP-custom | Check traffic of multiple network interfaces | X | > The services listed above are not created automatically when a host template is applied. To use them, [create a service manually](/docs/monitoring/basic-objects/services), then apply the service template you want. @@ -48,9 +54,9 @@ The connector brings the following service templates (sorted by the host templat #### Host discovery -| Rule name | Description | -|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Watchguard-SNMP-custom** host template | +| Rule name | Description | +|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SNMP Agents | Discover your resources through an SNMP subnet scan. You need to install the [Generic SNMP](./applications-protocol-snmp.md) connector to get the discovery rule and create a template mapper for the **Net-Watchguard-SNMP-custom** host template. | More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). @@ -66,23 +72,23 @@ and in the [following chapter](/docs/monitoring/discovery/services-discovery/#di ### 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 | |:--------------------------------------------|:------| | cluster-status | N/A | | members.detected.count | count | -| *members*#member-status | N/A | +| member-status | N/A | | *members*#member.health.hardware.percentage | % | | *members*#member.health.system.percentage | % | -| Metric name | Unit | +| Name | Unit | |:-------------------------------|:------| | cpu.utilization.1m.percentage | % | | cpu.utilization.5m.percentage | % | @@ -93,7 +99,7 @@ Here is the list of services for this connector, detailing all metrics linked to -| Metric name | Unit | +| Name | Unit | |:--------------------------------------|:------| | storage.partitions.count | count | | *disk_name*#storage.space.usage.bytes | B | @@ -104,12 +110,19 @@ Here is the list of services for this connector, detailing all metrics linked to -Coming soon +| Name | Unit | +|:------------------------|:------| +| hardware.port.status | N/A | +| hardware.port.count | count | +| hardware.sensors.status | N/A | +| hardware.sensors.count | count | +| hardware.unit.status | N/A | +| hardware.unit.count | count | -| Metric name | Unit | +| Name | Unit | |:------------------------------------------------|:------| | ipsec.tunnels.total.count | count | | *tunnel*#ipsec.tunnel.traffic.in.bitspersecond | b/s | @@ -118,7 +131,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:------------------------------------------|:------| | *policy*#policy.connections.current.count | count | | *policy*#policy.connections.total.count | count | @@ -130,7 +143,7 @@ Coming soon -| Metric name | Unit | +| Name | Unit | |:---------------------------------|:------| | system.connections.current.count | count | | system.traffic.in.bitspersecond | b/s | @@ -141,11 +154,14 @@ Coming soon -| Metric name | Unit | -|:-----------------------------------------------------|:------| -| *interface_name*#status | N/A | -| *interface_name*#interface.traffic.in.bitspersecond | b/s | -| *interface_name*#interface.traffic.out.bitspersecond | b/s | +| Name | Unit | +|:------------------------------------------------------|:------| +| status | N/A | +| status | N/A | +| *interface_name1*#interface.traffic.in.bitspersecond | b/s | +| *interface_name2*#interface.traffic.in.bitspersecond | b/s | +| *interface_name1*#interface.traffic.out.bitspersecond | b/s | +| *interface_name2*#interface.traffic.out.bitspersecond | b/s | @@ -154,7 +170,10 @@ Coming soon ### 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 @@ -165,12 +184,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: @@ -189,7 +205,7 @@ dnf install centreon-pack-network-watchguard-snmp ``` - + ```bash apt install centreon-pack-network-watchguard-snmp @@ -205,8 +221,8 @@ yum install centreon-pack-network-watchguard-snmp -2. Whatever the license type (*online* or *offline*), install the **Watchguard** connector through -the **Configuration > Connectors > Monitoring Connectors** menu. +2. Whatever the license type (*online* or *offline*), install the **Watchguard SNMP** connector through +the **Configuration > Monitoring Connector Manager** menu. ### Plugin @@ -236,7 +252,7 @@ dnf install centreon-plugin-Network-Watchguard-Snmp ``` - + ```bash apt install centreon-plugin-network-watchguard-snmp @@ -263,8 +279,8 @@ yum install centreon-plugin-Network-Watchguard-Snmp > When using SNMP v3, use the **SNMPEXTRAOPTIONS** macro to add specific authentication parameters. > More information in the [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. -| Macro | Description | Default value | Mandatory | -|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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. @@ -277,108 +293,108 @@ yum install centreon-plugin-Network-Watchguard-Snmp -| Macro | Description | Default value | Mandatory | -|:-----------------------------|:----------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCLUSTERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\} | | | -| CRITICALCLUSTERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\} | | | -| WARNINGMEMBERHEALTHHARDWARE | Thresholds | | | -| CRITICALMEMBERHEALTHHARDWARE | Thresholds | | | -| WARNINGMEMBERHEALTHSYSTEM | Thresholds | | | -| CRITICALMEMBERHEALTHSYSTEM | Thresholds | | | -| WARNINGMEMBERSDETECTED | Thresholds | | | -| CRITICALMEMBERSDETECTED | Thresholds | | | -| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{serial\} | | | -| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{serial\} | | | -| 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 | +|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCLUSTERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\} | | | +| CRITICALCLUSTERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\} | | | +| WARNINGMEMBERHEALTHHARDWARE | Threshold | | | +| CRITICALMEMBERHEALTHHARDWARE | Threshold | | | +| WARNINGMEMBERHEALTHSYSTEM | Threshold | | | +| CRITICALMEMBERHEALTHSYSTEM | Threshold | | | +| WARNINGMEMBERSDETECTED | Threshold | | | +| CRITICALMEMBERSDETECTED | Threshold | | | +| WARNINGMEMBERSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{serial\} | | | +| CRITICALMEMBERSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{serial\} | | | +| 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 | -|:--------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNING15MIN | Warning threshold | | | -| CRITICAL15MIN | Warning threshold | | | -| WARNING1MIN | Warning threshold | | | -| CRITICAL1MIN | Warning threshold | | | -| WARNING5MIN | Warning threshold | | | -| CRITICAL5MIN | Warning threshold | | | +| Macro | Description | Default value | Mandatory | +|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNING15MIN | Threshold | | | +| CRITICAL15MIN | Threshold | | | +| WARNING1MIN | Threshold | | | +| CRITICAL1MIN | Threshold | | | +| WARNING5MIN | Threshold | | | +| CRITICAL5MIN | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:-------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | -| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | -| WARNING | Warning threshold | 80 | | -| CRITICAL | Critical threshold | 90 | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| Macro | Description | Default value | Mandatory | +|:-------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage') | .* | | +| TRANSFORMSRC | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| TRANSFORMDST | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | | | +| WARNING | Warning threshold | 80 | | +| CRITICAL | Critical threshold | 90 | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -| Macro | Description | Default value | Mandatory | -|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| COMPONENT | Which component to check (default: '.*'). Can be: 'device' | .* | | +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check (default: '.*'). Can be: 'device' | .* | | | 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 name (can be a regexp) | | | -| WARNINGTUNNELSTOTAL | Thresholds | | | -| CRITICALTUNNELSTOTAL | Thresholds | | | -| WARNINGTUNNELTRAFFICIN | Thresholds | | | -| CRITICALTUNNELTRAFFICIN | Thresholds | | | -| WARNINGTUNNELTRAFFICOUT | Thresholds | | | -| CRITICALTUNNELTRAFFICOUT | Thresholds | | | +| Macro | Description | Default value | Mandatory | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERNAME | Filter name (can be a regexp) | | | +| WARNINGTUNNELSTOTAL | Threshold | | | +| CRITICALTUNNELSTOTAL | Threshold | | | +| WARNINGTUNNELTRAFFICIN | Threshold | | | +| CRITICALTUNNELTRAFFICIN | Threshold | | | +| WARNINGTUNNELTRAFFICOUT | Threshold | | | +| CRITICALTUNNELTRAFFICOUT | 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 policy name (can be a regexp) | | | -| WARNINGCURRENTCONNECTIONS | Warning threshold | | | -| CRITICALCURRENTCONNECTIONS | Critical threshold | | | -| WARNINGL2TRAFFIC | Warning threshold | | | -| CRITICALL2TRAFFIC | Critical threshold | | | -| WARNINGL3TRAFFIC | Warning threshold | | | -| CRITICALL3TRAFFIC | Critical threshold | | | -| WARNINGTOTALCONNECTIONS | Warning threshold | | | -| CRITICALTOTALCONNECTIONS | Critical threshold | | | +| Macro | Description | Default value | Mandatory | +|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERNAME | Filter policy name (can be a regexp) | | | +| WARNINGCURRENTCONNECTIONS | Threshold | | | +| CRITICALCURRENTCONNECTIONS | Threshold | | | +| WARNINGL2TRAFFIC | Threshold | | | +| CRITICALL2TRAFFIC | Threshold | | | +| WARNINGL3TRAFFIC | Threshold | | | +| CRITICALL3TRAFFIC | Threshold | | | +| WARNINGTOTALCONNECTIONS | Threshold | | | +| CRITICALTOTALCONNECTIONS | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:--------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| WARNINGCONNECTIONS | Thresholds | | | -| CRITICALCONNECTIONS | Thresholds | | | -| WARNINGINTRAFFIC | Thresholds | | | -| CRITICALINTRAFFIC | Thresholds | | | -| WARNINGOUTTRAFFIC | Thresholds | | | -| CRITICALOUTTRAFFIC | Thresholds | | | +| Macro | Description | Default value | Mandatory | +|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| WARNINGCONNECTIONS | Threshold | | | +| CRITICALCONNECTIONS | Threshold | | | +| WARNINGINTRAFFIC | Threshold | | | +| CRITICALINTRAFFIC | Threshold | | | +| WARNINGOUTTRAFFIC | Threshold | | | +| CRITICALOUTTRAFFIC | Threshold | | | | EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | | | -| Macro | Description | Default value | Mandatory | -|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| -| FILTER | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces') | .* | | -| WARNINGIN | Thresholds | 80 | | -| CRITICALIN | Thresholds | 90 | | -| WARNINGOUT | Thresholds | 80 | | -| CRITICALOUT | Thresholds | 90 | | +| Macro | Description | Default value | Mandatory | +|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTER | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name | .* | | +| WARNINGIN | Threshold | 80 | | +| CRITICALIN | Threshold | 90 | | +| WARNINGOUT | Threshold | 80 | | +| CRITICALOUT | Threshold | 90 | | | CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | | | -| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | @@ -463,61 +479,66 @@ The plugin brings the following modes: All generic options are listed here: -| Option | Description | -|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | -| --dyn-mode | Specify a mode with the module's path (advanced). | -| --list-mode | List all available modes. | -| --mode-version | Check minimal version of mode. If not, unknown error. | -| --version | Return the version of the plugin. | -| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | -| --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 | #### Modes options @@ -526,182 +547,155 @@ All available options for each service template are listed below: -| Option | Description | -|:--------------------------|:------------------------------------------------------------------------------------------------------------------------| -| --unknown-cluster-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{state\} | -| --warning-cluster-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\} | -| --critical-cluster-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\} | -| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{serial\} | -| --warning-member-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{serial\} | -| --critical-member-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{serial\} | -| --warning-* --critical-* | Thresholds. Can be: 'members-detected', 'member-health-hardware', 'member-health-system'. | +| Option | Description | +|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --unknown-cluster-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{state\} | +| --warning-cluster-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{state\} | +| --critical-cluster-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{state\} | +| --unknown-member-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %\{role\}, %\{serial\} | +| --warning-member-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{role\}, %\{serial\} | +| --critical-member-status | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %\{role\}, %\{serial\} | +| --warning-* --critical-* | Thresholds. Can be: 'members-detected', 'member-health-hardware', 'member-health-system'. | -| Option | Description | -|:-------------------------|:---------------------------------------------------------------------------------------------| -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^1min\|5min$' | -| --warning-* --critical-* | Warning threshold. Can be: '1min', '5min', '15min'. | +| Option | Description | +|:-------------------------|:-----------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^1min\|5min$' | +| --warning-* --critical-* | Warning threshold. Can be: '1min', '5min', '15min'. | -| Option | Description | -|:------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --warning-usage | Warning threshold. | -| --critical-usage | Critical threshold. | -| --warning-access | Warning threshold. | -| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | -| --add-access | Check storage access (readOnly, readWrite). | -| --units | Units of thresholds (default: '%') ('%', 'B'). | -| --free | Thresholds are on free space left. | -| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | -| --name | Allows to use storage name with option --storage instead ofstorage oid index. | -| --regexp | Allows to use regexp to filter storage (with option --name). | -| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | -| --path-best-match | Allows to select best path mount point (with --name). | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | -| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | -| --show-cache | Display cache storage data. | -| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | -| --filter-duplicate | Filter duplicate storages (in used size and total size). | -| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | +| Option | Description | +|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --warning-usage | Warning threshold. | +| --critical-usage | Critical threshold. | +| --warning-access | Warning threshold. | +| --critical-access | Critical threshold. Check if storage is readOnly: --critical-access=readOnly | +| --add-access | Check storage access (readOnly, readWrite). | +| --units | Units of thresholds (default: '%') ('%', 'B'). | +| --free | Thresholds are on free space left. | +| --storage | Set the storage (number expected) example: 1, 2,... (empty means 'check all storage'). | +| --name | Allows to use storage name with option --storage instead of storage oid index. | +| --regexp | Allows to use regexp to filter storage (with option --name). | +| --regexp-insensitive | Allows to use regexp non case-sensitive (with --regexp). | +| --path-best-match | Allows to select best path mount point (with --name). | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Choose OID used to filter storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --oid-display | Choose OID used to display storage (default: hrStorageDescr) (values: hrStorageDescr, hrFSMountPoint). | +| --display-transform-src --display-transform-dst | Modify the storage name displayed by using a regular expression. Example: adding --display-transform-src='dev' --display-transform-dst='run' will replace all occurrences of 'dev' with 'run' | +| --show-cache | Display cache storage data. | +| --space-reservation | Some filesystem has space reserved (like ext4 for root). The value is in percent of total (default: none) (results like 'df' command). | +| --filter-duplicate | Filter duplicate storages (in used size and total size). | +| --filter-storage-type | Filter storage types with a regexp (default: '^(hrStorageFixedDisk\|hrStorageNetworkDisk\|hrFSBerkeleyFFS)$'). | -| Option | Description | -|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --component | Which component to check (default: '.*'). Can be: 'device'. | -| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=device,network.* | -| --no-component | Define the expected status if no components are found (default: critical). | -| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='device.network,OK,down' | +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'device'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=device,network.* | +| --absent-problem | Return an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component\_name' or --absent-problem='component\_name,instance\_value'. | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='device.network,OK,down' | +| --warning | Define the warning threshold for temperatures (syntax: type,instance,threshold) Example: --warning='temperature,.*,30' | +| --critical | Define the critical threshold for temperatures (syntax: type,instance,threshold) Example: --critical='temperature,.*,40' | +| --warning-count-* | Define the warning threshold for the number of components of one type (replace '*' with the component type). | +| --critical-count-* | Define the critical threshold for the number of components of one type (replace '*' with the component type). package snmp\_standard::mode::components::device; use strict; use warnings; use centreon::plugins::misc; my %map\_status = (1 =\> 'unknown', 2 =\> 'running', 3 =\> 'warning', 4 =\> 'testing', 5 =\> 'down'); my %map\_type = ( '.1.3.6.1.2.1.25.3.1.1' =\> 'other', '.1.3.6.1.2.1.25.3.1.2' =\> 'unknown', '.1.3.6.1.2.1.25.3.1.3' =\> 'processor', '.1.3.6.1.2.1.25.3.1.4' =\> 'network', '.1.3.6.1.2.1.25.3.1.5' =\> 'printer', '.1.3.6.1.2.1.25.3.1.6' =\> 'diskStorage', '.1.3.6.1.2.1.25.3.1.10', =\> 'video', '.1.3.6.1.2.1.25.3.1.11' =\> 'audio', '.1.3.6.1.2.1.25.3.1.12' =\> 'coprocessor', '.1.3.6.1.2.1.25.3.1.13' =\> 'keyboard', '.1.3.6.1.2.1.25.3.1.14' =\> 'modem', '.1.3.6.1.2.1.25.3.1.15' =\> 'parallelPort', '.1.3.6.1.2.1.25.3.1.16' =\> 'pointing', '.1.3.6.1.2.1.25.3.1.17' =\> 'serialPort', '.1.3.6.1.2.1.25.3.1.18' =\> 'tape', '.1.3.6.1.2.1.25.3.1.19' =\> 'clock', '.1.3.6.1.2.1.25.3.1.20' =\> 'volatileMemory', '.1.3.6.1.2.1.25.3.1.21' =\> 'nonVolatileMemory', ); my $mapping = \{ hrDeviceType =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.2', map =\> \%map\_type \}, hrDeviceDescr =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.3' \}, hrDeviceStatus =\> \{ oid =\> '.1.3.6.1.2.1.25.3.2.1.5', map =\> \%map\_status \}, \}; my $oid\_hrDeviceEntry = '.1.3.6.1.2.1.25.3.2.1'; sub load \{ my ($self) = @\_; push @\{$self-\>\{request\}\}, \{ oid =\> $oid\_hrDeviceEntry \}; \} sub check \{ my ($self) = @\_; $self-\>\{output\}-\>output\_add(long\_msg =\> "Checking devices"); $self-\>\{components\}-\>\{device\} = \{name =\> 'devices', total =\> 0, skip =\> 0\}; return if ($self-\>check\_filter(section =\> 'device')); foreach my $oid ($self-\>\{snmp\}-\>oid\_lex\_sort(keys %\{$self-\>\{results\}-\>\{$oid\_hrDeviceEntry\}\})) \{ next if ($oid !~ /^$mapping-\>\{hrDeviceStatus\}-\>\{oid\}\.(.*)$/); my $instance = $1; my $result = $self-\>\{snmp\}-\>map\_instance(mapping =\> $mapping, results =\> $self-\>\{results\}-\>\{$oid\_hrDeviceEntry\}, instance =\> $instance); next if ($self-\>check\_filter(section =\> 'device', instance =\> $result-\>\{hrDeviceType\} . '.' . $instance)); $result-\>\{hrDeviceDescr\} = centreon::plugins::misc::trim($result-\>\{hrDeviceDescr\}); $self-\>\{components\}-\>\{device\}-\>\{total\}++; $self-\>\{output\}-\>output\_add(long\_msg =\> sprintf("device '%s' status is '%s' \[instance = %s\]", $result-\>\{hrDeviceDescr\}, $result-\>\{hrDeviceStatus\}, $result-\>\{hrDeviceType\} . '.' . $instance)); my $exit = $self-\>get\_severity(label =\> 'default', section =\> 'device.' . $result-\>\{hrDeviceType\}, value =\> $result-\>\{hrDeviceStatus\}); if (!$self-\>\{output\}-\>is\_status(value =\> $exit, compare =\> 'ok', litteral =\> 1)) \{ $self-\>\{output\}-\>output\_add(severity =\> $exit, short\_msg =\> sprintf("Device '%s' status is '%s'", $result-\>\{hrDeviceDescr\}, $result-\>\{hrDeviceStatus\})); \} \} \} 1; | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-name | Filter name (can be a regexp). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='tunnels-total' | -| --warning-* --critical-* | Thresholds. Can be: 'tunnels-total', 'tunnel-traffic-in', 'tunnel-traffic-out'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='tunnels-total' | +| --filter-name | Filter name (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'tunnels-total', 'tunnel-traffic-in', 'tunnel-traffic-out'. | -| Option | Description | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-connections$' | -| --filter-name | Filter policy name (can be a regexp). | -| --warning-* | Warning threshold. Can be: 'total-connections', 'current-connections' 'l3-traffic' (b/s), 'l2-traffic' (b/s). | -| --critical-* | Critical threshold. Can be: 'total-connections', 'current-connections' 'l3-traffic' (b/s), 'l2-traffic' (b/s). | +| Option | Description | +|:------------------|:--------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^total-connections$' | +| --filter-name | Filter policy name (can be a regexp). | +| --warning-* | Warning threshold. Can be: 'total-connections', 'current-connections' 'l3-traffic' (b/s), 'l2-traffic' (b/s). | +| --critical-* | Critical threshold. Can be: 'total-connections', 'current-connections' 'l3-traffic' (b/s), 'l2-traffic' (b/s). | -| Option | Description | -|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^connections$' | -| --warning-* --critical-* | Thresholds. Can be: 'in-traffic', 'out-traffic', 'connections'. | +| Option | Description | +|:-------------------------|:------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='^connections$' | +| --warning-* --critical-* | Thresholds. Can be: 'in-traffic', 'out-traffic', 'connections'. | -| Option | Description | -|:------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| --memcached | Memcached server to use (only one server). | -| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | -| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | -| --redis-db | Set Redis database index. | -| --failback-file | Failback on a local file if Redis connection fails. | -| --memexpiration | Time to keep data in seconds (default: 86400). | -| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | -| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | -| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | -| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | -| --statefile-key | Define the key to encrypt/decrypt the cache. | -| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | -| --add-global | Check global port statistics (by default if no --add-* option is set). | -| --add-status | Check interface status. | -| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | -| --add-traffic | Check interface traffic. | -| --add-errors | Check interface errors. | -| --add-cast | Check interface cast. | -| --add-speed | Check interface speed. | -| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | -| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | -| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | -| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | -| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | -| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | -| --nagvis-perfdata | Display traffic perfdata to be compatible with nagvis widget. | -| --interface | Set the interface (number expected) example: 1,2,... (empty means 'check all interfaces'). | -| --name | Allows you to define the interface (in option --interface) byname instead of OID index. The name matching mode supports regular expressions. | -| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | -| --speed-in | Set interface speed for incoming traffic (in Mb). | -| --speed-out | Set interface speed for outgoing traffic (in Mb). | -| --map-speed-dsl | Get interface speed configuration for interface type 'adsl' and 'vdsl2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | -| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | -| --force-counters32 | Force to use 32 bits counters (even in snmp v2c and v3). Should be used when 64 bits counters are buggy. | -| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | -| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | -| --oid-extra-display | Add an OID to display. | -| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | -| --show-cache | Display cache interface data. | +| Option | Description | +|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --add-global | Check global port statistics (by default if no --add-* option is set). | +| --add-status | Check interface status. | +| --add-duplex-status | Check duplex status (with --warning-status and --critical-status). | +| --add-traffic | Check interface traffic. | +| --add-errors | Check interface errors. | +| --add-cast | Check interface cast. | +| --add-speed | Check interface speed. | +| --add-volume | Check interface data volume between two checks (not supposed to be graphed, useful for BI reporting). | +| --check-metrics | If the expression is true, metrics are checked (default: '%\{opstatus\} eq "up"'). | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%\{admstatus\} eq "up" and %\{opstatus\} ne "up"'). You can use the following variables: %\{admstatus\}, %\{opstatus\}, %\{duplexstatus\}, %\{display\} | +| --warning-* --critical-* | Thresholds. Can be: 'total-port', 'total-admin-up', 'total-admin-down', 'total-oper-up', 'total-oper-down', 'in-traffic', 'out-traffic', 'in-error', 'in-discard', 'out-error', 'out-discard', 'in-ucast', 'in-bcast', 'in-mcast', 'out-ucast', 'out-bcast', 'out-mcast', 'speed' (b/s). | +| --units-traffic | Units of thresholds for the traffic (default: 'percent\_delta') ('percent\_delta', 'bps', 'counter'). | +| --units-errors | Units of thresholds for errors/discards (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --units-cast | Units of thresholds for communication types (default: 'percent\_delta') ('percent\_delta', 'percent', 'delta', 'deltaps', 'counter'). | +| --nagvis-perfdata | Display traffic perfdata to be compatible with NagVis widget. | +| --interface | Check only the interfaces with the specified IDs (OID indexes, e.g.: 1,2,...). If empty, all interfaces will be monitored. To filter on interface names, see --name. | +| --name | With this option, the interfaces will be filtered by name (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bit counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | From 3dc5a4fb2c22f6f0077548b86b2bc6bfdffe42f9 Mon Sep 17 00:00:00 2001 From: Lucie Tirand <123162035+lucie-tirand@users.noreply.github.com> Date: Tue, 25 Nov 2025 14:14:30 +0100 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: cg-tw <83637804+cg-tw@users.noreply.github.com> --- .../procedures/applications-protocol-udp.md | 7 ++++--- .../procedures/network-cisco-ironport-snmp.md | 14 +++++++------- .../network-firewalls-paloalto-standard-snmp.md | 8 ++++---- .../procedures/network-firewalls-stonesoft.md | 6 +++--- .../procedures/network-perle-ids-snmp.md | 4 ++-- 5 files changed, 20 insertions(+), 19 deletions(-) diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-udp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-udp.md index 24cca4ad62e6..1217304f0fc3 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-udp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/applications-protocol-udp.md @@ -61,9 +61,10 @@ Voici le tableau des services pour ce connecteur, détaillant les métriques et ## Prérequis -The SNMP agent must be enabled and configured on the resource. Please refer to the official documentation from the manufacturer/publisher. -Your resource may require a list of addresses authorized to query it to be set up. -Please ensure that the addresses of the Centreon pollers are included in this list. +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. ## Installer le connecteur de supervision diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md index 3f3d34ee90d0..72e740c0dbd3 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-ironport-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-cisco-ironport-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 **Cisco IronPort 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 @@ -40,9 +40,9 @@ Le connecteur apporte les modèles de service suivants |:---------------------|:----------------------------------------------------|:----------------------------------------------------------|:----------:| | Mail-Usage | Net-Cisco-Ironport-Mail-Usage-SNMP-custom | Contrôle l'utilisation du mail | | | Proxy-Usage | Net-Cisco-Ironport-Proxy-Usage-SNMP-custom | Contrôle l'utilisation du proxy | | -| Traffic-Generic-Id | Net-Cisco-Ironport-Traffic-Generic-Id-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Generic-Name | Net-Cisco-Ironport-Traffic-Generic-Name-SNMP-custom | Contrôle le traffic réseau d'une interface réseau | | -| Traffic-Global | Net-Cisco-Ironport-Traffic-Global-SNMP-custom | Contrôle le traffic réseau de plusieurs interfaces réseau | X | +| Traffic-Generic-Id | Net-Cisco-Ironport-Traffic-Generic-Id-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Generic-Name | Net-Cisco-Ironport-Traffic-Generic-Name-SNMP-custom | Contrôle le trafic réseau d'une interface réseau | | +| Traffic-Global | Net-Cisco-Ironport-Traffic-Global-SNMP-custom | Contrôle le trafic réseau de plusieurs interfaces réseau | X | > Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, [créez un service manuellement](/docs/monitoring/basic-objects/services) et appliquez le modèle de service souhaité. @@ -168,7 +168,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 : @@ -205,7 +205,7 @@ yum install centreon-pack-network-cisco-ironport-snmp 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Cisco IronPort 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 @@ -258,7 +258,7 @@ yum install centreon-plugin-Network-Cisco-Ironport-Snmp 3. Appliquez le modèle d'hôte **Net-Cisco-Ironport-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/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md index 1a90ea5eff19..79624e63af47 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-paloalto-standard-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 **Palo Alto firewall 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 @@ -185,7 +185,7 @@ Centreon vers le serveur supervisé. ### 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 : @@ -222,7 +222,7 @@ yum install centreon-pack-network-firewalls-paloalto-standard-snmp 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Palo Alto firewall 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 @@ -275,7 +275,7 @@ yum install centreon-plugin-Network-Firewalls-Paloalto-Standard-Snmp 3. Appliquez le modèle d'hôte **Net-PaloAlto-Standard-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/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md index a71e1318b29c..559499baf170 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-stonesoft.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-firewalls-stonesoft.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 **Stonesoft 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 @@ -184,7 +184,7 @@ La communication doit être possible sur le port UDP 161 depuis le collecteur Ce ### 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 : @@ -221,7 +221,7 @@ yum install centreon-pack-network-firewalls-stonesoft 2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Stonesoft 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 diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-perle-ids-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-perle-ids-snmp.md index 4cad6b066955..74ad70da544d 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-perle-ids-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-perle-ids-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 **Perle IDS 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 @@ -29,7 +29,7 @@ Le connecteur apporte les modèles de service suivants |:----------------|:------------------------------------------|:-----------------------------------------| | Alarms | Net-Perle-Ids-Alarms-SNMP-custom | Contrôle les alarmes | | Hardware-Global | Net-Perle-Ids-Hardware-Global-SNMP-custom | Contrôle le matériel | -| System-Usage | Net-Perle-Ids-System-Usage-SNMP-custom | Contrôle l'utilisation cpu et la mémoire | +| System-Usage | Net-Perle-Ids-System-Usage-SNMP-custom | Contrôle l'utilisation CPU et la mémoire | > Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Perle-Ids-SNMP-custom** est utilisé.