diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-versa-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-versa-snmp.md index df21da3f024a..fc7b4d182c35 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-versa-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-versa-snmp.md @@ -5,119 +5,153 @@ title: Versa SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Dépendances du connecteur de supervision -## Vue d'ensemble +Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur **Versa SNMP** +depuis la page **Configuration > Gestionnaire de connecteurs de supervision** : +* [Base Pack](./base-generic.md) -Versa Networks est un fournisseur d'architectures Cloud sécurisées. -Versa Networks propose notamment des solutions SD-WAN (Software-Defined Wide Area Network). +## Contenu du pack -Le connecteur de supervision Centreon utilise le protocole SNMP pour se connecter, récupérer des informations -et des métriques relatives aux équipements Versa Networks +### Modèles -## Contenu du connecteur de supervision +Le connecteur de supervision **Versa SNMP** apporte un modèle d'hôte : -### Objets supervisés +* **Net-Versa-SNMP-custom** -* CPE -* Branch -* Gateway - -### Règles de découverte +Le connecteur apporte les modèles de service suivants +(classés selon le modèle d'hôte auquel ils sont rattachés) : - + + +| Alias | Modèle de service | Description | +|:--------|:------------------------------|:-------------------------------------| +| Devices | Net-Versa-Devices-SNMP-custom | Contrôle l'utilisation des systèmes | + +> Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Versa-SNMP-custom** est utilisé. + + + + +| Alias | Modèle de service | Description | Découverte | +|:-----------|:---------------------------------|:-------------------------------------|:----------:| +| Bgp-Peers | Net-Versa-Bgp-Peers-SNMP-custom | Contrôle l'utilisation des systèmes | | +| Interfaces | Net-Versa-Interfaces-SNMP-custom | Contrôle les interfaces | X | +| Ipsec | Net-Versa-Ipsec-SNMP-custom | Contrôle les tunnels IPsec | X | +| Qos-Policy | Net-Versa-Qos-Policy-SNMP-custom | Contrôle les politiques QoS | | +| Sdwan | Net-Versa-Sdwan-SNMP-custom | Contrôle les règles SD-Wan | 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é. -| Nom de la règle | Description | -|:--------------------------------- |:-------------------------------------------------------------------------------------------- | -| Net-Versa-SNMP-Ipsec-Name | Découvre les tunnels IPsec et supervise le trafic et les paquets | -| Net-Versa-SNMP-Sdwan-Name | Découvre les règles SD-WAN et supervise le trafic | -| Net-Versa-SNMP-Traffic-Name | Découvre les interfaces réseaux et supervise le statut et l'utilisation de la bande passante | -| Net-Versa-SNMP-Packet-Errors-Name | Découvre les interfaces réseaux et supervise les paquets en erreurs | +> Si la case **Découverte** est cochée, cela signifie qu'une règle de découverte de service existe pour ce service. -### Métriques collectées +### Règles de découverte + +#### 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-Versa-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-Versa-SNMP-Ipsec-Name | Découvre les tunnels IPsec et supervise le trafic et les paquets | +| Net-Versa-SNMP-Packet-Errors-Name | Découvre les interfaces réseau en utilisant leur nom et supervise les paquets erronés et rejetés | +| Net-Versa-SNMP-Sdwan-Name | Découvre les règles SD-WAN et supervise le trafic | +| Net-Versa-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 et statuts rattachés à chaque service. -| Metric name | Description | Unit | -|:------------------------ |:------------------- |:---- | -| status | Status of the peers | | -| peer.update.last.seconds | Last update by peer | s | +| Nom | Unité | +|:---------------------------------|:------| +| status | N/A | +| *peers*#peer.update.last.seconds | s | -| Metric name | Description | Unit | -|:--------------------------------- | :------------------------------------------ |:----- | -| device.cpu.utilization.percentage | Device CPU utilization | % | -| device.memory.usage.percentage | Device Memory usage | % | -| device.sessions.active.count | Number of actives sessions on the device | Count | -| device.sessions.active.percentage | Percentage of active sessions on the device | % | -| device.sessions.failed.count | Number of failed sessions on the device | Count | -| device.sessions.failed.percentage | Percentage of failed sessions on the device | % | +| Nom | Unité | +|:--------------------------------------------|:------| +| *devices*#device.cpu.utilization.percentage | % | +| *devices*#device.memory.usage.percentage | % | +| *devices*#device.sessions.active.count | count | +| *devices*#device.sessions.active.percentage | % | +| *devices*#device.sessions.failed.count | count | +| *devices*#device.sessions.failed.percentage | % | -| Metric name | Description | Unit | -|:----------------------------------------- |:------------------------------------------------------ |:---- | -| status | Status of the interface | | -| interface.traffic.in.bitspersecond | Incoming traffic going through the interface | b/s | -| interface.traffic.out.bitspersecond | Outgoing traffic going through the interface | b/s | -| interface.packets.in.errors.percentage | Incoming errored packets going through the interface | % | -| interface.packets.out.errors.percentage | Outgoing errored packets going through the interface | % | -| interface.packets.in.discards.percentage | Incoming discarded packets going through the interface | % | -| interface.packets.out.discards.percentage | Outgoing discarded packets going through the interface | % | +| Nom | Unité | +|:----------------------------------------------------------|:------| +| 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 | % | +| *interface_name*#interface.packets.in.error.percentage | % | +| *interface_name*#interface.packets.out.discard.percentage | % | +| *interface_name*#interface.packets.out.error.percentage | % | -| Metric name | Description | Unit | -|:-------------------------------- |:-------------------------------------------------- |:----- | -| ipsec.packets.in.count | Number of incoming packets trough the IPsec tunnel | Count | -| ipsec.traffic.in.bytespersecond | Incoming traffic going through the IPsec tunnel | B/s | -| ipsec.packets.out.count | Number of outgoing packets trough the IPsec tunnel | Count | -| ipsec.traffic.out.bytespersecond | Outcoming taffic going through the IPsec tunnel | B/s | -| ipsec.packets.invalid.count | Number of invalid packets through the IPsec tunnel | Count | -| ipsec.ike.disconnected.count | number of IKE disconnect by IPsec tunnel | Count | +| Nom | Unité | +|:-----------------------------------------|:------| +| *ipsec*#ipsec.packets.in.count | count | +| *ipsec*#ipsec.packets.invalid.count | count | +| *ipsec*#ipsec.traffic.in.bytespersecond | B/s | +| *ipsec*#ipsec.packets.out.count | count | +| *ipsec*#ipsec.traffic.out.bytespersecond | B/s | +| *ipsec*#ipsec.ike.disconnected.count | count | -* Par QoS policy - -| Metric name | Description | Unit | -|:------------------------------------------- |:----------------------------------------- |:---- | -| qos.policy.hit.count | Number of hits by QoS policy | Count | -| qos.policy.sessions.deny.count | Number of sessions denied by QoS Policy | Count | -| qos.policy.packets.dropped.count | Number of packets dropped by Qos Policy | Count | -| qos.policy.traffic.dropped.bytespersecond | Traffic dropped by Qos Policy | B/s | -| qos.policy.packets.forwarded.count | Number of packets forwarded by Qos Policy | Count | -| qos.policy.traffic.forwarded.bytespersecond | Traffic forwarded by QoS Policy | B/s | - -* Par application Qos Policy - -| Metric name | Description | Unit | -|:---------------------------------------------- |:----------------------------------------------------- |:----- | -| appqos.policy.hit.count | Number of hits by Application Qos Policy | Count | -| appqos.policy.packets.dropped.count | Number of packets dropped by Application Qos Policy | Count | -| appqos.policy.traffic.dropped.bytespersecond | Traffic dropped by Application Qos Policy | B/s | -| appqos.policy.packets.forwarded.count | Number of packets forwarded by Application Qos Policy | Count | -| appqos.policy.traffic.forwarded.bytespersecond | Traffic forwarded by QoS Policy | B/s | +| Nom | Unité | +|:--------------------------------------------------------------|:------| +| *qospolicy*#qos.policy.hit.count | count | +| *qospolicy*#qos.policy.sessions.deny.count | count | +| *qospolicy*#qos.policy.packets.dropped.count | count | +| *qospolicy*#qos.policy.traffic.dropped.bytespersecond | B/s | +| *qospolicy*#qos.policy.packets.forwarded.count | count | +| *qospolicy*#qos.policy.traffic.forwarded.bytespersecond | B/s | +| *appqospolicy*#appqos.policy.hit.count | count | +| *appqospolicy*#appqos.policy.packets.dropped.count | count | +| *appqospolicy*#appqos.policy.traffic.dropped.bytespersecond | B/s | +| *appqospolicy*#appqos.policy.packets.forwarded.count | count | +| *appqospolicy*#appqos.policy.traffic.forwarded.bytespersecond | B/s | -| Metric name | Description | Unit | -|:--------------------------------------- |:----------------------------------------------- |:----- | -| sdwan.policy.hit.count | Number of hits by SDWAN policy | Count | -| sdwan.policy.packets.in.count | Number of incoming packets by SDWAN policy | Count | -| sdwan.policy.traffic.in.bytespersecond | Incoming traffic going through by SDWAN policy | B/s | -| sdwan.policy.packets.out.count | Number of outgoing packets by SDWAN policy | Count | -| sdwan.policy.traffic.out.bytespersecond | Outcoming traffic going through by SDWAN Policy | B/s | +| Nom | Unité | +|:-------------------------------------------------|:------| +| *sdwan1*#sdwan.policy.hit.count | count | +| *sdwan2*#sdwan.policy.hit.count | count | +| *sdwan1*#sdwan.policy.packets.in.count | count | +| *sdwan2*#sdwan.policy.packets.in.count | count | +| *sdwan1*#sdwan.policy.traffic.in.bytespersecond | B/s | +| *sdwan2*#sdwan.policy.traffic.in.bytespersecond | B/s | +| *sdwan1*#sdwan.policy.packets.out.count | count | +| *sdwan2*#sdwan.policy.packets.out.count | count | +| *sdwan1*#sdwan.policy.traffic.out.bytespersecond | B/s | +| *sdwan2*#sdwan.policy.traffic.out.bytespersecond | B/s | @@ -126,115 +160,512 @@ et des métriques relatives aux équipements Versa Networks ### Configuration SNMP de l'équipement -La documentation officielle Versa Networks détaille les étapes pour activer et configurer le service SNMP. +L'agent SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. +Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. +Veillez à ce que les adresses des collecteurs Centreon y figurent bien. ### Flux réseau -La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers l'équipement Versa Networks supervisé. +La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers la ressource supervisée. + +## Installer le connecteur de supervision -## Installation +### 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**. +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 : - + -1. Installer le Plugin sur chaque collecteur Centreon devant superviser des équipements -Versa Networks : +```bash +dnf install centreon-pack-network-versa-snmp +``` + + + ```bash -yum install centreon-plugin-Network-Versa-Snmp +dnf install centreon-pack-network-versa-snmp ``` -2. Sur l'interface Web de Centreon, installer le connecteur de supervision *Versa SNMP* -depuis la page **Configuration > Gestionnaire de connecteurs de supervision** + + + +```bash +apt install centreon-pack-network-versa-snmp +``` + + + + +```bash +yum install centreon-pack-network-versa-snmp +``` - + -1. Installer le Plugin sur chaque collecteur Centreon devant superviser des équipements -Versa Networks : +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Versa SNMP** +depuis l'interface web et le menu **Configuration > Gestionnaire de 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 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. + +> Plus d'informations dans la section [Installer le plugin](/docs/monitoring/pluginpacks/#installer-le-plugin). + +Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation : + + + ```bash -yum install centreon-plugin-Network-Versa-Snmp +dnf install centreon-plugin-Network-Versa-Snmp ``` -2. Installer le RPM du connecteur de supervision sur le serveur Centreon Central: + + ```bash -yum install centreon-pack-network-versa-snmp +dnf install centreon-plugin-Network-Versa-Snmp +``` + + + + +```bash +apt install centreon-plugin-network-versa-snmp ``` -3. Sur l'interface Web de Centreon, installer le connecteur de supervision *Versa SNMP* -depuis la page **Configuration > Gestionnaire de connecteurs de supervision** + + + +```bash +yum install centreon-plugin-Network-Versa-Snmp +``` -## Configuration +## Utiliser le connecteur de supervision + +### 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 **Net-Versa-SNMP-custom**. -* Ajoutez un nouvel Hôte depuis la page "Configuration > Hôtes" -* Complétez les champs *Communauté SNMP* et *Version SNMP* -* Appliquez le Modèle d'Hôte *Net-Versa-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). -> Si vous utilisez SNMP en version 3, vous devez configurer les paramètres spécifiques associés via la macro SNMPEXTRAOPTIONS. -> Plus d'informations dans la section [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping). +| Macro | Description | Valeur par défaut | Obligatoire | +|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| 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). | | | -| Mandatory | Name | Description | -| :-------- | :--------------- | :--------------------------------------------- | -| | SNMPEXTRAOPTIONS | Configure your own SNMPv3 credentials combo | +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. -## FAQ +### Utiliser un modèle de service issu du connecteur -### Comment puis-je tester le Plugin et que signifient les options des commandes ? +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. -Une fois le Plugin installé, vous pouvez tester celui-ci directement en ligne de commande -depuis un collecteur Centreon en vous connectant avec l'utilisateur *centreon-engine*: + + + +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------|:-----------:| +| FILTERAS | Filter based on AS number (regexp allowed) | | | +| FILTERLOCALADDR | Filter based on local IP:PORT of peers (regexp allowed) | | | +| FILTERREMOTEADDR | Filter based on remote IP:PORT of peers (regexp allowed) | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | %{state} !~ /established/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | | | +| WARNINGUPDATELAST | Threshold | | | +| CRITICALUPDATELAST | 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 | +|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERVSNID | Filter monitoring on vsn ID (can be a regexp) | | | +| WARNINGCPUUTILIZATION | Threshold | | | +| CRITICALCPUUTILIZATION | Threshold | | | +| WARNINGMEMORYUSAGE | Threshold | | | +| CRITICALMEMORYUSAGE | Threshold | | | +| WARNINGSESSIONSACTIVE | Threshold | | | +| CRITICALSESSIONSACTIVE | Threshold | | | +| WARNINGSESSIONSACTIVEPRCT | Threshold | | | +| CRITICALSESSIONSACTIVEPRCT | Threshold | | | +| WARNINGSESSIONSFAILED | Threshold | | | +| CRITICALSESSIONSFAILED | Threshold | | | +| WARNINGSESSIONSFAILEDPRCT | Threshold | | | +| CRITICALSESSIONSFAILEDPRCT | 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 | +|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| +| 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 | 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 | | | +| 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 --no-skipped-counters --use-new-perfdata | | + + + + +| Macro | Description | Valeur par défaut | Obligatoire | +|:------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERORG | Filter monitoring on 'org' -organization name- (can be a regexp) | | | +| WARNINGIKEDISCONNECTED | Threshold | | | +| CRITICALIKEDISCONNECTED | Threshold | | | +| WARNINGPACKETSIN | Threshold | | | +| CRITICALPACKETSIN | Threshold | | | +| WARNINGPACKETSINVALID | Threshold | | | +| CRITICALPACKETSINVALID | Threshold | | | +| WARNINGPACKETSOUT | Threshold | | | +| CRITICALPACKETSOUT | Threshold | | | +| WARNINGTRAFFICIN | Threshold | | | +| CRITICALTRAFFICIN | Threshold | | | +| WARNINGTRAFFICOUT | Threshold | | | +| CRITICALTRAFFICOUT | 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 | +|:-------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERORG | Filter monitoring on 'org' -organization name- (can be a regexp). An org may have 1 to n associated policies and rules | | | +| FILTERPOLICY | Filter monitoring on 'policy' -policy name- (can be a regexp). A policy may have 1 to n associated rules | | | +| FILTERRULE | Filter monitoring on 'rule' -rule name- (can be a regexp) | | | +| WARNINGAPPQOSPOLICYHIT | Threshold | | | +| CRITICALAPPQOSPOLICYHIT | Threshold | | | +| WARNINGAPPQOSPOLICYPACKETSDROPPED | Threshold | | | +| CRITICALAPPQOSPOLICYPACKETSDROPPED | Threshold | | | +| WARNINGAPPQOSPOLICYPACKETSFORWARDED | Threshold | | | +| CRITICALAPPQOSPOLICYPACKETSFORWARDED | Threshold | | | +| WARNINGAPPQOSPOLICYTRAFFICDROPPED | Threshold | | | +| CRITICALAPPQOSPOLICYTRAFFICDROPPED | Threshold | | | +| WARNINGAPPQOSPOLICYTRAFFICFORWARDED | Threshold | | | +| CRITICALAPPQOSPOLICYTRAFFICFORWARDED | Threshold | | | +| WARNINGQOSPOLICYHIT | Threshold | | | +| CRITICALQOSPOLICYHIT | Threshold | | | +| WARNINGQOSPOLICYPACKETSDROPPED | Threshold | | | +| CRITICALQOSPOLICYPACKETSDROPPED | Threshold | | | +| WARNINGQOSPOLICYPACKETSFORWARDED | Threshold | | | +| CRITICALQOSPOLICYPACKETSFORWARDED | Threshold | | | +| WARNINGQOSPOLICYSESSIONSDENY | Threshold | | | +| CRITICALQOSPOLICYSESSIONSDENY | Threshold | | | +| WARNINGQOSPOLICYTRAFFICDROPPED | Threshold | | | +| CRITICALQOSPOLICYTRAFFICDROPPED | Threshold | | | +| WARNINGQOSPOLICYTRAFFICFORWARDED | Threshold | | | +| CRITICALQOSPOLICYTRAFFICFORWARDED | 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 | +|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERORG | Filter monitoring on 'org' -organization name- (can be a regexp). An org may have 1 to n associated policies and rules | | | +| FILTERPOLICY | Filter monitoring on 'policy' -policy name- (can be a regexp). A policy may have 1 to n associated rules | | | +| FILTERRULE | Filter monitoring on 'rule' -rule name- (can be a regexp) | | | +| WARNINGHIT | Threshold | | | +| CRITICALHIT | Threshold | | | +| WARNINGPACKETSIN | Threshold | | | +| CRITICALPACKETSIN | Threshold | | | +| WARNINGPACKETSOUT | Threshold | | | +| CRITICALPACKETSOUT | Threshold | | | +| WARNINGTRAFFICIN | Threshold | | | +| CRITICALTRAFFICIN | Threshold | | | +| WARNINGTRAFFICOUT | Threshold | | | +| CRITICALTRAFFICOUT | 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 | | + + + + +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`). 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 /usr/lib/centreon/plugins/centreon_versa_snmp.pl \ - --plugin=network::versa::snmp::plugin \ - --mode=devices \ - --hostname=10.0.0.1 \ - --snmp-version='2c' \ - --snmp-community='mysnmpcommunity' \ - --warning-sessions-active-prct='80' \ - --critical-sessions-active-prct='90' \ - --verbose + --plugin=network::versa::snmp::plugin \ + --mode=sdwan \ + --hostname='10.0.0.1' \ + --snmp-version='2c' \ + --snmp-community='my-snmp-community' \ + --filter-org='' \ + --filter-policy='' \ + --filter-rule='' \ + --warning-hit='' \ + --critical-hit='' \ + --warning-packets-in='' \ + --critical-packets-in='' \ + --warning-traffic-in='' \ + --critical-traffic-in='' \ + --warning-packets-out='' \ + --critical-packets-out='' \ + --warning-traffic-out='' \ + --critical-traffic-out='' \ + --verbose ``` -La commande devrait retourner un message de sortie de la forme ci-dessous: +La commande devrait retourner un message de sortie similaire à : ```bash -OK: Device '0' cpu load: 8.00 %, memory used: 10.00%, sessions active: 0 (1000000), sessions failed: 0 (1000000) | -'0#device.cpu.utilization.percentage'=8.00%;;;0;100 '0#device.memory.usage.percentage'=10.00%;;;0;100 -'0#device.sessions.active.count'=0;;;0;1000000 '0#device.sessions.active.percentage'=0.00%;0:80;0:90;0;100 -'0#device.sessions.failed.count'=0;;;0;1000000 '0#device.sessions.active.percentage'=0.00%;;;0;100 -Device '0' cpu load: 8.00 %, memory used: 10.00%, sessions active: 0 (1000000), sessions failed: 0 (1000000) +OK: All SD-Wan are ok | 'sdwan1#sdwan.policy.hit.count'=32961;;;; 'sdwan2#sdwan.policy.hit.count'=69808;;;; 'sdwan1#sdwan.policy.packets.in.count'=12844;;;; 'sdwan2#sdwan.policy.packets.in.count'=88400;;;; 'sdwan1#sdwan.policy.traffic.in.bytespersecond'=78360;;;; 'sdwan2#sdwan.policy.traffic.in.bytespersecond'=56836;;;; 'sdwan1#sdwan.policy.packets.out.count'=1916;;;; 'sdwan2#sdwan.policy.packets.out.count'=31072;;;; 'sdwan1#sdwan.policy.traffic.out.bytespersecond'=77254;;;; 'sdwan2#sdwan.policy.traffic.out.bytespersecond'=51000;;;; ``` -Dans cet exemple, le Plugin récupère l'utilisation d'un équipement Versa Networks (```--plugin=network::versa::snmp::plugin --mode=devices```) +### 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. -identifié par l'adresse IP *10.0.0.1* (```--hostname=10.0.0.1```). Les paramètres de communauté et de version SNMP (```--snmp-version='2c' --snmp-community='mysnmpcommunity'```) -correspondants sont renseignés afin de pouvoir joindre l'équipement. +### Modes disponibles -Une alarme WARNING sera ainsi déclenchée si le pourcentage d'utilisation des sessions actives est supérieur à 80% (```--warning-sessions-active-prct='80'```); -l'alarme sera de type CRITICAL au delà de 90% de cette même utilisation (```--critical-sessions-active-prct='90'```). +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. -Pour chaque mode, la liste de toutes les métriques, seuils associés et options complémentaires peut être affichée -en ajoutant le paramètre ```--help``` à la commande : +Tous les modes disponibles peuvent être affichés en ajoutant le paramètre +`--list-mode` à la commande : ```bash -/usr/lib/centreon/plugins/centreon_versa_snmp.pl --plugin=network::versa::snmp::plugin --mode=devices --help +/usr/lib/centreon/plugins/centreon_versa_snmp.pl \ + --plugin=network::versa::snmp::plugin \ + --list-mode ``` -### J'obtiens le message d'erreur suivant: +Le plugin apporte les modes suivants : + +| Mode | Modèle de service associé | +|:-----------------------------------------------------------------------------------------------------------------------------|:---------------------------------| +| bgp-peers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/bgppeers.pm)] | Net-Versa-Bgp-Peers-SNMP-custom | +| devices [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/devices.pm)] | Net-Versa-Devices-SNMP-custom | +| interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-Versa-Interfaces-SNMP-custom | +| ipsec [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/ipsec.pm)] | Net-Versa-Ipsec-SNMP-custom | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | +| list-ipsec [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/listipsec.pm)] | Used for service discovery | +| list-sdwan [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/listsdwan.pm)] | Used for service discovery | +| qos-policy [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/qospolicy.pm)] | Net-Versa-Qos-Policy-SNMP-custom | +| sdwan [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/sdwan.pm)] | Net-Versa-Sdwan-SNMP-custom | + +### Options disponibles + +#### Options génériques + +Les options génériques sont listées ci-dessous : + +| Option | Description | +|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). | +| --dyn-mode | Specify a mode with the module's path (advanced). | +| --list-mode | List all available modes. | +| --mode-version | Check minimal version of mode. If not, unknown error. | +| --version | Return the version of the plugin. | +| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | +| --hostname | Name or address of the host to monitor (mandatory). | +| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | +| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | +| --snmp-port | UDP port to send the SNMP request to (default: 161). | +| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | +| --snmp-retries | Maximum number of retries (default: 5). | +| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | +| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | +| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | +| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | +| --snmp-cache-file | Use SNMP cache file. | +| --snmp-username | SNMP v3 only: User name (securityName). | +| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | +| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | +| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | +| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | +| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | +| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | +| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | +| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | +| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | +| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | +| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | +| --verbose | Display extended status information (long output). | +| --debug | Display debug messages. | +| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | +| --filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. | +| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '\_max' suffix). Example: it will split 'used\_prct'=26.93%;0:80;0:90;0;100 into 'used\_prct'=26.93%;0:80;0:90;0;100 'used\_prct\_max'=100%;;;; | +| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard\|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traffic\_(in\|out)\_$1)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | + +#### Options des modes + +Les options disponibles pour chaque modèle de services sont listées ci-dessous : + + + -#### UNKNOWN: SNMP GET Request : Timeout +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-as | Filter based on AS number (regexp allowed) | +| --filter-local-addr | Filter based on local IP:PORT of peers (regexp allowed) | +| --filter-remote-addr | Filter based on remote IP:PORT of peers (regexp allowed) | +| --warning-updates | Warning threshold on last update (seconds) | +| --critical-updates | Critical threshold on last update (seconds) | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%{state} !~ /established/'). You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | -Si vous obtenez ce message, cela signifie que vous ne parvenez pas à contacter l'équipement Versa Networks sur le port UDP/161, -ou que la communauté SNMP configurée n'est pas correcte. Il est également possible qu'un pare-feu bloque le flux. + + -#### UNKNOWN: SNMP GET Request : Cant get a single value. +| Option | Description | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='cpu\_load' | +| --filter-vsn-id | Filter monitoring on vsn ID (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'cpu-utilization', 'memory-usage', 'sessions-active', 'sessions-active-prct', 'sessions-failed', 'sessions-failed-prct'. | -Les causes de cette erreur peuvent être les suivantes: - * cet équipement ne supporte ou n'embarque pas la MIB utilisée par ce mode - * les autorisations données à l'utilisateur en SNMP sont trop restreintes. + + + +| 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 (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | + + + + +| Option | Description | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='traffic' | +| --filter-org | Filter monitoring on 'org' -organization name- (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'packets-in', 'packets-invalid', 'traffic-in', 'packets-out', 'traffic-out', 'ike-disconnected'. | + + + + +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='qos-policy-hit' | +| --filter-org | Filter monitoring on 'org' -organization name- (can be a regexp). An org may have 1 to n associated policies and rules | +| --filter-policy | Filter monitoring on 'policy' -policy name- (can be a regexp). A policy may have 1 to n associated rules | +| --filter-rule | Filter monitoring on 'rule' -rule name- (can be a regexp) | +| --warning-* --critical-* | Thresholds for QoS policy: Can be: 'qos-policy-hit', 'qos-policy-sessions-deny', 'qos-policy-packets-dropped', 'qos-policy-traffic-dropped', 'qos-policy-packets-forwarded', 'qos-policy-traffic-forwarded'. Thresholds for applications QoS policy: Can be: 'appqos-policy-hit', 'appqos-policy-packets-dropped', 'appqos-policy-traffic-dropped', 'appqos-policy-packets-forwarded', 'appqos-policy-traffic-forwarded'. | + + + + +| Option | Description | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='traffic' | +| --filter-org | Filter monitoring on 'org' -organization name- (can be a regexp). An org may have 1 to n associated policies and rules | +| --filter-policy | Filter monitoring on 'policy' -policy name- (can be a regexp). A policy may have 1 to n associated rules | +| --filter-rule | Filter monitoring on 'rule' -rule name- (can be a regexp) | +| --warning-* --critical-* | Thresholds. Can be: 'hit', 'packets-in', 'traffic-in', 'packets-out', 'traffic-out'. | + + + + +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 +/usr/lib/centreon/plugins/centreon_versa_snmp.pl \ + --plugin=network::versa::snmp::plugin \ + --mode=sdwan \ + --help +``` diff --git a/pp/integrations/plugin-packs/procedures/network-versa-snmp.md b/pp/integrations/plugin-packs/procedures/network-versa-snmp.md index ae588e321420..eae95a868521 100644 --- a/pp/integrations/plugin-packs/procedures/network-versa-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-versa-snmp.md @@ -5,118 +5,152 @@ title: Versa SNMP import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +## Connector dependencies -## Overview +The following monitoring connectors will be installed when you install the **Versa SNMP** connector through the +**Configuration > Monitoring Connector Manager** menu: +* [Base Pack](./base-generic.md) -Versa Networks provides secure cloud IP architecture. -In particular, SD-WAN that aims to phase out conventional WAN infrastructures. +## Pack assets -The Centreon Monitoring Connector relies on the SNMP protocol to query and collect status and metrics of the Versa equipments. +### Templates -## Monitoring Connector assets +The Monitoring Connector **Versa SNMP** brings a host template: -### Monitored objects +* **Net-Versa-SNMP-custom** -* CPE -* Branch -* Gateway - -### Discovery Rules +The connector brings the following service templates (sorted by the host template they are attached to): - + + +| Service Alias | Service Template | Service Description | +|:--------------|:------------------------------|:--------------------------------| +| Devices | Net-Versa-Devices-SNMP-custom | Check device system statistics | + +> The services listed above are created automatically when the **Net-Versa-SNMP-custom** host template is used. + + + + +| Service Alias | Service Template | Service Description | Discovery | +|:--------------|:---------------------------------|:--------------------------------|:----------:| +| Bgp-Peers | Net-Versa-Bgp-Peers-SNMP-custom | Check device system statistics | | +| Interfaces | Net-Versa-Interfaces-SNMP-custom | Check interfaces | X | +| Ipsec | Net-Versa-Ipsec-SNMP-custom | Check IPsec tunnels | X | +| Qos-Policy | Net-Versa-Qos-Policy-SNMP-custom | Check QoS policies | | +| Sdwan | Net-Versa-Sdwan-SNMP-custom | Check SD-Wan rules | X | -| Rule Name | Description | -|:--------------------------------- |:------------------------------------------------------------- | -| Net-Versa-SNMP-Ipsec-Name | Discover IPSec tunnels and monitor traffic and packets | -| Net-Versa-SNMP-Sdwan-Name | Discover SDWAN rules and monitor traffic/hits | -| Net-Versa-SNMP-Traffic-Name | Discover network interfaces and monitor bandwidth utilization | -| Net-Versa-SNMP-Packet-Errors-Name | Discover network interfaces and monitor packet errors/discard | +> 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. + +> If **Discovery** is checked, it means a service discovery rule exists for this service template. -### Collected metrics +### 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-Versa-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 | +|:----------------------------------|:----------------------------------------------------------------------| +| Net-Versa-SNMP-Ipsec-Name | Discover IPSec tunnels and monitor traffic and packets | +| Net-Versa-SNMP-Packet-Errors-Name | Discover network interfaces and monitor errored and discarded packets | +| Net-Versa-SNMP-Sdwan-Name | Discover SDWAN rules and monitor traffic/hits | +| Net-Versa-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 and statuses linked to each service. -| Metric name | Description | Unit | -|:------------------------ |:------------------- |:---- | -| status | Status of the peers | | -| peer.update.last.seconds | Last update by peer | s | +| Name | Unit | +|:---------------------------------|:------| +| status | N/A | +| *peers*#peer.update.last.seconds | s | -| Metric name | Description | Unit | -|:--------------------------------- | :------------------------------------------ |:----- | -| device.cpu.utilization.percentage | Device CPU utilization | % | -| device.memory.usage.percentage | Device Memory usage | % | -| device.sessions.active.count | Number of actives sessions on the device | Count | -| device.sessions.active.percentage | Percentage of active sessions on the device | % | -| device.sessions.failed.count | Number of failed sessions on the device | Count | -| device.sessions.failed.percentage | Percentage of failed sessions on the device | % | +| Name | Unit | +|:--------------------------------------------|:------| +| *devices*#device.cpu.utilization.percentage | % | +| *devices*#device.memory.usage.percentage | % | +| *devices*#device.sessions.active.count | count | +| *devices*#device.sessions.active.percentage | % | +| *devices*#device.sessions.failed.count | count | +| *devices*#device.sessions.failed.percentage | % | -| Metric name | Description | Unit | -|:----------------------------------------- |:------------------------------------------------------ |:---- | -| status | Status of the interface | | -| interface.traffic.in.bitspersecond | Incoming traffic going through the interface | b/s | -| interface.traffic.out.bitspersecond | Outgoing traffic going through the interface | b/s | -| interface.packets.in.errors.percentage | Incoming errored packets going through the interface | % | -| interface.packets.out.errors.percentage | Outgoing errored packets going through the interface | % | -| interface.packets.in.discards.percentage | Incoming discarded packets going through the interface | % | -| interface.packets.out.discards.percentage | Outgoing discarded packets going through the interface | % | +| Name | Unit | +|:----------------------------------------------------------|:------| +| 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 | % | +| *interface_name*#interface.packets.in.error.percentage | % | +| *interface_name*#interface.packets.out.discard.percentage | % | +| *interface_name*#interface.packets.out.error.percentage | % | -| Metric name | Description | Unit | -|:-------------------------------- |:-------------------------------------------------- |:----- | -| ipsec.packets.in.count | Number of incoming packets trough the IPsec tunnel | Count | -| ipsec.traffic.in.bytespersecond | Incoming traffic going through the IPsec tunnel | B/s | -| ipsec.packets.out.count | Number of outgoing packets trough the IPsec tunnel | Count | -| ipsec.traffic.out.bytespersecond | Outcoming taffic going through the IPsec tunnel | B/s | -| ipsec.packets.invalid.count | Number of invalid packets through the IPsec tunnel | Count | -| ipsec.ike.disconnected.count | number of IKE disconnect by IPsec tunnel | Count | +| Name | Unit | +|:-----------------------------------------|:------| +| *ipsec*#ipsec.packets.in.count | count | +| *ipsec*#ipsec.packets.invalid.count | count | +| *ipsec*#ipsec.traffic.in.bytespersecond | B/s | +| *ipsec*#ipsec.packets.out.count | count | +| *ipsec*#ipsec.traffic.out.bytespersecond | B/s | +| *ipsec*#ipsec.ike.disconnected.count | count | -* by QoS policy - -| Metric name | Description | Unit | -|:------------------------------------------- |:----------------------------------------- |:---- | -| qos.policy.hit.count | Number of hits by QoS policy | Count | -| qos.policy.sessions.deny.count | Number of sessions denied by QoS Policy | Count | -| qos.policy.packets.dropped.count | Number of packets dropped by Qos Policy | Count | -| qos.policy.traffic.dropped.bytespersecond | Traffic dropped by Qos Policy | B/s | -| qos.policy.packets.forwarded.count | Number of packets forwarded by Qos Policy | Count | -| qos.policy.traffic.forwarded.bytespersecond | Traffic forwarded by QoS Policy | B/s | - -* by Application Qos Policy - -| Metric name | Description | Unit | -|:---------------------------------------------- |:----------------------------------------------------- |:----- | -| appqos.policy.hit.count | Number of hits by Application Qos Policy | Count | -| appqos.policy.packets.dropped.count | Number of packets dropped by Application Qos Policy | Count | -| appqos.policy.traffic.dropped.bytespersecond | Traffic dropped by Application Qos Policy | B/s | -| appqos.policy.packets.forwarded.count | Number of packets forwarded by Application Qos Policy | Count | -| appqos.policy.traffic.forwarded.bytespersecond | Traffic forwarded by QoS Policy | B/s | +| Name | Unit | +|:--------------------------------------------------------------|:------| +| *qospolicy*#qos.policy.hit.count | count | +| *qospolicy*#qos.policy.sessions.deny.count | count | +| *qospolicy*#qos.policy.packets.dropped.count | count | +| *qospolicy*#qos.policy.traffic.dropped.bytespersecond | B/s | +| *qospolicy*#qos.policy.packets.forwarded.count | count | +| *qospolicy*#qos.policy.traffic.forwarded.bytespersecond | B/s | +| *appqospolicy*#appqos.policy.hit.count | count | +| *appqospolicy*#appqos.policy.packets.dropped.count | count | +| *appqospolicy*#appqos.policy.traffic.dropped.bytespersecond | B/s | +| *appqospolicy*#appqos.policy.packets.forwarded.count | count | +| *appqospolicy*#appqos.policy.traffic.forwarded.bytespersecond | B/s | -| Metric name | Description | Unit | -|:--------------------------------------- |:----------------------------------------------- |:----- | -| sdwan.policy.hit.count | Number of hits by SDWAN policy | Count | -| sdwan.policy.packets.in.count | Number of incoming packets by SDWAN policy | Count | -| sdwan.policy.traffic.in.bytespersecond | Incoming traffic going through by SDWAN policy | B/s | -| sdwan.policy.packets.out.count | Number of outgoing packets by SDWAN policy | Count | -| sdwan.policy.traffic.out.bytespersecond | Outcoming traffic going through by SDWAN Policy | B/s | +| Name | Unit | +|:-------------------------------------------------|:------| +| *sdwan1*#sdwan.policy.hit.count | count | +| *sdwan2*#sdwan.policy.hit.count | count | +| *sdwan1*#sdwan.policy.packets.in.count | count | +| *sdwan2*#sdwan.policy.packets.in.count | count | +| *sdwan1*#sdwan.policy.traffic.in.bytespersecond | B/s | +| *sdwan2*#sdwan.policy.traffic.in.bytespersecond | B/s | +| *sdwan1*#sdwan.policy.packets.out.count | count | +| *sdwan2*#sdwan.policy.packets.out.count | count | +| *sdwan1*#sdwan.policy.traffic.out.bytespersecond | B/s | +| *sdwan2*#sdwan.policy.traffic.out.bytespersecond | B/s | @@ -125,108 +159,512 @@ The Centreon Monitoring Connector relies on the SNMP protocol to query and colle ### Device Configuration -The SNMP agent must be configured and running on the Versa Networks device. -Please refer to the manufacturer documentation to achieve this. +The SNMP agent must be enabled and configured on the resource. Please refer to the official documentation from the manufacturer/publisher. +Your resource may require a list of addresses authorized to query it to be set up. +Please ensure that the addresses of the Centreon pollers are included in this list. ### Network flows -The Centreon Poller must be able to reach the UDP/161 SNMP port of the Versa Networks device. +The Centreon Poller must be able to reach the UDP 161 port of the Versa Networks device. + +## Installing the monitoring connector -## Installation +### Pack + +1. If the platform uses an *online* license, you can skip the package installation +instruction below as it is not required to have the connector displayed within the +**Configuration > Monitoring Connector Manager** menu. +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: - + -1. Install the Centreon package on every Centreon Poller expected to monitor -Versa Networks devices: +```bash +dnf install centreon-pack-network-versa-snmp +``` + + + ```bash -yum install centreon-plugin-Network-Versa-Snmp +dnf install centreon-pack-network-versa-snmp +``` + + + + +```bash +apt install centreon-pack-network-versa-snmp ``` -2. On the Centreon Web interface, install the *Versa SNMP* Monitoring Connector -through **Configuration > Monitoring Connector Manager** page. + + + +```bash +yum install centreon-pack-network-versa-snmp +``` - + + +2. Whatever the license type (*online* or *offline*), install the **Versa SNMP** connector through +the **Configuration > Monitoring Connector Manager** menu. + +### Plugin -1. Install the Centreon package on every Centreon Poller expected to monitor -Versa Networks devices: +Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. +When this feature is enabled, you can skip the installation part below. + +You still have to manually install the plugin on the poller(s) when: +- Automatic plugin installation is turned off +- You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet + +> More information in the [Installing the plugin](/docs/monitoring/pluginpacks/#installing-the-plugin) section. + +Use the commands below according to your operating system's package manager: + + + ```bash -yum install centreon-plugin-Network-Versa-Snmp +dnf install centreon-plugin-Network-Versa-Snmp +``` + + + + +```bash +dnf install centreon-plugin-Network-Versa-Snmp ``` -2. Install the Centreon Monitoring Connector RPM on the Centreon Central server: + + ```bash -yum install centreon-pack-network-versa-snmp +apt install centreon-plugin-network-versa-snmp ``` -3. On the Centreon Web interface, install the *Versa SNMP* Monitoring Connector -through **Configuration > Monitoring Connector Manager** page. + + + +```bash +yum install centreon-plugin-Network-Versa-Snmp +``` -## Host configuration +## Using the monitoring connector + +### Using a host template provided by the connector -* Add a new Host and apply the *Net-Versa-SNMP-Custom* Host Template -* Fill the SNMP Version and Community fields according to the device's configuration +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-Versa-SNMP-custom** template to the host. -> When using SNMP v3, use the SNMPEXTRAOPTIONS Macro to add specific authentication parameters +> 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. -| Mandatory | Name | Description | -| :-------- | :--------------- | :--------------------------------------------- | -| | SNMPEXTRAOPTIONS | Configure your own SNMPv3 credentials combo | +| 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. + +### Using a service template provided by the connector + +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). -## FAQ + + + +| Macro | Description | Default value | Mandatory | +|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------|:-----------:| +| FILTERAS | Filter based on AS number (regexp allowed) | | | +| FILTERLOCALADDR | Filter based on local IP:PORT of peers (regexp allowed) | | | +| FILTERREMOTEADDR | Filter based on remote IP:PORT of peers (regexp allowed) | | | +| CRITICALSTATUS | Define the conditions to match for the status to be CRITICAL. You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | %{state} !~ /established/ | | +| WARNINGSTATUS | Define the conditions to match for the status to be WARNING. You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | | | +| WARNINGUPDATELAST | Threshold | | | +| CRITICALUPDATELAST | 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 | +|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERVSNID | Filter monitoring on vsn ID (can be a regexp) | | | +| WARNINGCPUUTILIZATION | Threshold | | | +| CRITICALCPUUTILIZATION | Threshold | | | +| WARNINGMEMORYUSAGE | Threshold | | | +| CRITICALMEMORYUSAGE | Threshold | | | +| WARNINGSESSIONSACTIVE | Threshold | | | +| CRITICALSESSIONSACTIVE | Threshold | | | +| WARNINGSESSIONSACTIVEPRCT | Threshold | | | +| CRITICALSESSIONSACTIVEPRCT | Threshold | | | +| WARNINGSESSIONSFAILED | Threshold | | | +| CRITICALSESSIONSFAILED | Threshold | | | +| WARNINGSESSIONSFAILEDPRCT | Threshold | | | +| CRITICALSESSIONSFAILEDPRCT | 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 | +|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------|:-----------:| +| 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 | 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 | | | +| 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 --no-skipped-counters --use-new-perfdata | | + + + + +| Macro | Description | Default value | Mandatory | +|:------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERORG | Filter monitoring on 'org' -organization name- (can be a regexp) | | | +| WARNINGIKEDISCONNECTED | Threshold | | | +| CRITICALIKEDISCONNECTED | Threshold | | | +| WARNINGPACKETSIN | Threshold | | | +| CRITICALPACKETSIN | Threshold | | | +| WARNINGPACKETSINVALID | Threshold | | | +| CRITICALPACKETSINVALID | Threshold | | | +| WARNINGPACKETSOUT | Threshold | | | +| CRITICALPACKETSOUT | Threshold | | | +| WARNINGTRAFFICIN | Threshold | | | +| CRITICALTRAFFICIN | Threshold | | | +| WARNINGTRAFFICOUT | Threshold | | | +| CRITICALTRAFFICOUT | 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 | | -### How to test the Plugin and what are the main options for ? + + + +| Macro | Description | Default value | Mandatory | +|:-------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERORG | Filter monitoring on 'org' -organization name- (can be a regexp). An org may have 1 to n associated policies and rules | | | +| FILTERPOLICY | Filter monitoring on 'policy' -policy name- (can be a regexp). A policy may have 1 to n associated rules | | | +| FILTERRULE | Filter monitoring on 'rule' -rule name- (can be a regexp) | | | +| WARNINGAPPQOSPOLICYHIT | Threshold | | | +| CRITICALAPPQOSPOLICYHIT | Threshold | | | +| WARNINGAPPQOSPOLICYPACKETSDROPPED | Threshold | | | +| CRITICALAPPQOSPOLICYPACKETSDROPPED | Threshold | | | +| WARNINGAPPQOSPOLICYPACKETSFORWARDED | Threshold | | | +| CRITICALAPPQOSPOLICYPACKETSFORWARDED | Threshold | | | +| WARNINGAPPQOSPOLICYTRAFFICDROPPED | Threshold | | | +| CRITICALAPPQOSPOLICYTRAFFICDROPPED | Threshold | | | +| WARNINGAPPQOSPOLICYTRAFFICFORWARDED | Threshold | | | +| CRITICALAPPQOSPOLICYTRAFFICFORWARDED | Threshold | | | +| WARNINGQOSPOLICYHIT | Threshold | | | +| CRITICALQOSPOLICYHIT | Threshold | | | +| WARNINGQOSPOLICYPACKETSDROPPED | Threshold | | | +| CRITICALQOSPOLICYPACKETSDROPPED | Threshold | | | +| WARNINGQOSPOLICYPACKETSFORWARDED | Threshold | | | +| CRITICALQOSPOLICYPACKETSFORWARDED | Threshold | | | +| WARNINGQOSPOLICYSESSIONSDENY | Threshold | | | +| CRITICALQOSPOLICYSESSIONSDENY | Threshold | | | +| WARNINGQOSPOLICYTRAFFICDROPPED | Threshold | | | +| CRITICALQOSPOLICYTRAFFICDROPPED | Threshold | | | +| WARNINGQOSPOLICYTRAFFICFORWARDED | Threshold | | | +| CRITICALQOSPOLICYTRAFFICFORWARDED | 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 | | + + + -Once the Plugin installed, log into your Centreon Poller CLI using the *centreon-engine* user account -and test the Plugin by running the following command: +| Macro | Description | Default value | Mandatory | +|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERORG | Filter monitoring on 'org' -organization name- (can be a regexp). An org may have 1 to n associated policies and rules | | | +| FILTERPOLICY | Filter monitoring on 'policy' -policy name- (can be a regexp). A policy may have 1 to n associated rules | | | +| FILTERRULE | Filter monitoring on 'rule' -rule name- (can be a regexp) | | | +| WARNINGHIT | Threshold | | | +| CRITICALHIT | Threshold | | | +| WARNINGPACKETSIN | Threshold | | | +| CRITICALPACKETSIN | Threshold | | | +| WARNINGPACKETSOUT | Threshold | | | +| CRITICALPACKETSOUT | Threshold | | | +| WARNINGTRAFFICIN | Threshold | | | +| CRITICALTRAFFICIN | Threshold | | | +| WARNINGTRAFFICOUT | Threshold | | | +| CRITICALTRAFFICOUT | 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 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 resource using a command like this one (replace the sample values by yours): ```bash /usr/lib/centreon/plugins/centreon_versa_snmp.pl \ - --plugin=network::versa::snmp::plugin \ - --mode=devices \ - --hostname=10.0.0.1 \ - --snmp-version='2c' \ - --snmp-community='mysnmpcommunity' \ - --warning-sessions-active-prct='80' \ - --critical-sessions-active-prct='90' \ - --verbose + --plugin=network::versa::snmp::plugin \ + --mode=sdwan \ + --hostname='10.0.0.1' \ + --snmp-version='2c' \ + --snmp-community='my-snmp-community' \ + --filter-org='' \ + --filter-policy='' \ + --filter-rule='' \ + --warning-hit='' \ + --critical-hit='' \ + --warning-packets-in='' \ + --critical-packets-in='' \ + --warning-traffic-in='' \ + --critical-traffic-in='' \ + --warning-packets-out='' \ + --critical-packets-out='' \ + --warning-traffic-out='' \ + --critical-traffic-out='' \ + --verbose ``` -Expected command output is shown below: +The expected command output is shown below: ```bash -OK: Device '0' cpu load: 8.00 %, memory used: 10.00%, sessions active: 0 (1000000), sessions failed: 0 (1000000) | -'0#device.cpu.utilization.percentage'=8.00%;;;0;100 '0#device.memory.usage.percentage'=10.00%;;;0;100 -'0#device.sessions.active.count'=0;;;0;1000000 '0#device.sessions.active.percentage'=0.00%;0:80;0:90;0;100 -'0#device.sessions.failed.count'=0;;;0;1000000 '0#device.sessions.active.percentage'=0.00%;;;0;100 -Device '0' cpu load: 8.00 %, memory used: 10.00%, sessions active: 0 (1000000), sessions failed: 0 (1000000) +OK: All SD-Wan are ok | 'sdwan1#sdwan.policy.hit.count'=32961;;;; 'sdwan2#sdwan.policy.hit.count'=69808;;;; 'sdwan1#sdwan.policy.packets.in.count'=12844;;;; 'sdwan2#sdwan.policy.packets.in.count'=88400;;;; 'sdwan1#sdwan.policy.traffic.in.bytespersecond'=78360;;;; 'sdwan2#sdwan.policy.traffic.in.bytespersecond'=56836;;;; 'sdwan1#sdwan.policy.packets.out.count'=1916;;;; 'sdwan2#sdwan.policy.packets.out.count'=31072;;;; 'sdwan1#sdwan.policy.traffic.out.bytespersecond'=77254;;;; 'sdwan2#sdwan.policy.traffic.out.bytespersecond'=51000;;;; ``` -The command above monitors a Versa Networks device usage (```--plugin=network::versa::snmp::plugin --mode=devices```) identified +### Troubleshooting -by the IP address *10.0.0.1* (```--hostname=10.0.0.1```). As the Plugin is using the SNMP protocol to request the device, the related -*community* and *version* are specified (```--snmp-version='2c' --snmp-community='mysnmpcommunity'```). +Please find the [troubleshooting documentation](../getting-started/how-to-guides/troubleshooting-plugins.md) +for Centreon Plugins typical issues. -This command would trigger a WARNING alarm if the active sessions used raise over 80% of the device session capacity -(```--warning-sessions-active-prct='80'```) and a CRITICAL alarm over 90% (```--critical-sessions-active-prct='90'```). +### Available modes -For each Plugin mode, all the options as well as all the available thresholds can be displayed by adding the ```--help``` -parameter to the command: +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 -/usr/lib/centreon/plugins/centreon_versa_snmp.pl --plugin=network::versa::snmp::plugin --mode=devices --help +/usr/lib/centreon/plugins/centreon_versa_snmp.pl \ + --plugin=network::versa::snmp::plugin \ + --list-mode ``` -### UNKNOWN: SNMP GET Request : Timeout +The plugin brings the following modes: + +| Mode | Linked service template | +|:-----------------------------------------------------------------------------------------------------------------------------|:---------------------------------| +| bgp-peers [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/bgppeers.pm)] | Net-Versa-Bgp-Peers-SNMP-custom | +| devices [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/devices.pm)] | Net-Versa-Devices-SNMP-custom | +| interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/interfaces.pm)] | Net-Versa-Interfaces-SNMP-custom | +| ipsec [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/ipsec.pm)] | Net-Versa-Ipsec-SNMP-custom | +| list-interfaces [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/snmp_standard/mode/listinterfaces.pm)] | Used for service discovery | +| list-ipsec [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/listipsec.pm)] | Used for service discovery | +| list-sdwan [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/listsdwan.pm)] | Used for service discovery | +| qos-policy [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/qospolicy.pm)] | Net-Versa-Qos-Policy-SNMP-custom | +| sdwan [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/versa/snmp/mode/sdwan.pm)] | Net-Versa-Sdwan-SNMP-custom | + +### Available options + +#### Generic options + +All generic options are listed here: + +| Option | Description | +|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --mode | Define the mode in which you want the plugin to be executed (see --list-mode). | +| --dyn-mode | Specify a mode with the module's path (advanced). | +| --list-mode | List all available modes. | +| --mode-version | Check minimal version of mode. If not, unknown error. | +| --version | Return the version of the plugin. | +| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | +| --hostname | Name or address of the host to monitor (mandatory). | +| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | +| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | +| --snmp-port | UDP port to send the SNMP request to (default: 161). | +| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | +| --snmp-retries | Maximum number of retries (default: 5). | +| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | +| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | +| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | +| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | +| --snmp-cache-file | Use SNMP cache file. | +| --snmp-username | SNMP v3 only: User name (securityName). | +| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | +| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | +| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | +| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | +| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | +| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | +| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | +| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | +| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | +| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | +| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | +| --verbose | Display extended status information (long output). | +| --debug | Display debug messages. | +| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | +| --filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. | +| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '\_max' suffix). Example: it will split 'used\_prct'=26.93%;0:80;0:90;0;100 into 'used\_prct'=26.93%;0:80;0:90;0;100 'used\_prct\_max'=100%;;;; | +| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --change-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[max\]\] Common examples: =over 4 Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' =back | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation\[,\[newuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard\|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traffic\_(in\|out)\_$1)' =back | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-short-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. =head1 DESCRIPTION B\. =cut | +| --filter-counters | Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\|yyyy$' | + +#### Modes options + +All available options for each service template are listed below: + + + + +| Option | Description | +|:---------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-as | Filter based on AS number (regexp allowed) | +| --filter-local-addr | Filter based on local IP:PORT of peers (regexp allowed) | +| --filter-remote-addr | Filter based on remote IP:PORT of peers (regexp allowed) | +| --warning-updates | Warning threshold on last update (seconds) | +| --critical-updates | Critical threshold on last update (seconds) | +| --unknown-status | Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | +| --warning-status | Define the conditions to match for the status to be WARNING. You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | +| --critical-status | Define the conditions to match for the status to be CRITICAL (default: '%{state} !~ /established/'). You can use the following variables: %{local\_addr}, %{remote\_addr}, %{as}, %{state}, %{display} | + + + + +| Option | Description | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='cpu\_load' | +| --filter-vsn-id | Filter monitoring on vsn ID (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'cpu-utilization', 'memory-usage', 'sessions-active', 'sessions-active-prct', 'sessions-failed', 'sessions-failed-prct'. | + + + + +| 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 (given in option --interface) instead of OID index. The name matching mode supports regular expressions. | +| --regex-id | With this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs. | +| --speed | Set interface speed for incoming/outgoing traffic (in Mb). | +| --speed-in | Set interface speed for incoming traffic (in Mb). | +| --speed-out | Set interface speed for outgoing traffic (in Mb). | +| --map-speed-dsl | Get interface speed configuration for interfaces of type 'ADSL' and 'VDSL2'. Syntax: --map-speed-dsl=interface-src-name,interface-dsl-name E.g: --map-speed-dsl=Et0.835,Et0-vdsl2 | +| --force-counters64 | Force to use 64 bits counters only. Can be used to improve performance. | +| --force-counters32 | Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy. | +| --reload-cache-time | Time in minutes before reloading cache file (default: 180). | +| --oid-filter | Define the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-display | Define the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr). | +| --oid-extra-display | Add an OID to display. | +| --display-transform-src --display-transform-dst | Modify the interface name displayed by using a regular expression. Example: adding --display-transform-src='eth' --display-transform-dst='ens' will replace all occurrences of 'eth' with 'ens' | +| --show-cache | Display cache interface data. | + + + + +| Option | Description | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='traffic' | +| --filter-org | Filter monitoring on 'org' -organization name- (can be a regexp). | +| --warning-* --critical-* | Thresholds. Can be: 'packets-in', 'packets-invalid', 'traffic-in', 'packets-out', 'traffic-out', 'ike-disconnected'. | -If you get this message, you're probably facing one of theses issues: -* The SNMP agent of the device isn't started or is misconfigured -* An external device is blocking the request (firewall, ...) + + + +| Option | Description | +|:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='qos-policy-hit' | +| --filter-org | Filter monitoring on 'org' -organization name- (can be a regexp). An org may have 1 to n associated policies and rules | +| --filter-policy | Filter monitoring on 'policy' -policy name- (can be a regexp). A policy may have 1 to n associated rules | +| --filter-rule | Filter monitoring on 'rule' -rule name- (can be a regexp) | +| --warning-* --critical-* | Thresholds for QoS policy: Can be: 'qos-policy-hit', 'qos-policy-sessions-deny', 'qos-policy-packets-dropped', 'qos-policy-traffic-dropped', 'qos-policy-packets-forwarded', 'qos-policy-traffic-forwarded'. Thresholds for applications QoS policy: Can be: 'appqos-policy-hit', 'appqos-policy-packets-dropped', 'appqos-policy-traffic-dropped', 'appqos-policy-packets-forwarded', 'appqos-policy-traffic-forwarded'. | + + + + +| Option | Description | +|:-------------------------|:---------------------------------------------------------------------------------------------------------------------------| +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='traffic' | +| --filter-org | Filter monitoring on 'org' -organization name- (can be a regexp). An org may have 1 to n associated policies and rules | +| --filter-policy | Filter monitoring on 'policy' -policy name- (can be a regexp). A policy may have 1 to n associated rules | +| --filter-rule | Filter monitoring on 'rule' -rule name- (can be a regexp) | +| --warning-* --critical-* | Thresholds. Can be: 'hit', 'packets-in', 'traffic-in', 'packets-out', 'traffic-out'. | + + + + +All available options for a given mode can be displayed by adding the +`--help` parameter to the command: + +```bash +/usr/lib/centreon/plugins/centreon_versa_snmp.pl \ + --plugin=network::versa::snmp::plugin \ + --mode=sdwan \ + --help +```