diff --git a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-sophos-es-snmp.md b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-sophos-es-snmp.md index 480c8a5ff58b..901d454d5c05 100644 --- a/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-sophos-es-snmp.md +++ b/i18n/fr/docusaurus-plugin-content-docs-pp/current/integrations/plugin-packs/procedures/network-sophos-es-snmp.md @@ -2,48 +2,389 @@ id: network-sophos-es-snmp title: Sophos ES --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; -## Prerequisites +## Contenu du pack -### Centreon Plugin +### Modèles -Install this plugin on each needed poller: +Le connecteur de supervision **Sophos ES** apporte un modèle d'hôte : -``` shell +* **Net-Sophos-Es-SNMP-custom** + +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 | +|:--------|:----------------------------------|:---------------------------------------| +| Health | Net-Sophos-Es-Health-SNMP-custom | Contrôle l'état de santé de la machine | +| Message | Net-Sophos-Es-Message-SNMP-custom | Contrôle les statistiques des messages | + +> Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte **Net-Sophos-Es-SNMP-custom** est utilisé. + + + + +### 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-Sophos-Es-SNMP-custom**. | + +Rendez-vous sur la [documentation dédiée](/docs/monitoring/discovery/hosts-discovery) pour en savoir plus sur la découverte automatique d'hôtes. + +### Métriques & statuts collectés + +Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service. + + + + +| Métrique | Unité | +|:------------ |:---- | +| status | N/A | + + + + +| Métrique | Unité | +|:------------------|:------| +| queue | N/A | +| total-msg-in | /s | +| total-msg-out | /s | +| *sea_msg*#msg-in | /s | +| *sea_msg*#msg-out | /s | + +> Pour obtenir ce nouveau format de métrique, incluez la valeur **--use-new-perfdata** dans la macro de service **EXTRAOPTIONS**. + + + + +## Prérequis + +### Configuration SNMP + +L'agent SNMP doit être activé et configuré sur l'équipement. Veuillez vous référer à la documentation officielle du constructeur/éditeur. + +### Flux réseau + +La communication doit être possible sur le port UDP 161 depuis le collecteur +Centreon vers la ressource supervisée. + +## Installer le connecteur de supervision + +### 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 : + + + + +```bash +dnf install centreon-pack-network-sophos-es-snmp +``` + + + + +```bash +dnf install centreon-pack-network-sophos-es-snmp +``` + + + + +```bash +apt install centreon-pack-network-sophos-es-snmp +``` + + + + +```bash +yum install centreon-pack-network-sophos-es-snmp +``` + + + + +2. Quel que soit le type de la licence (*online* ou *offline*), installez le connecteur **Sophos ES** +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 +dnf install centreon-plugin-Network-Sophos-Es-Snmp +``` + + + + +```bash +dnf install centreon-plugin-Network-Sophos-Es-Snmp +``` + + + + +```bash +apt install centreon-plugin-network-sophos-es-snmp +``` + + + + +```bash yum install centreon-plugin-Network-Sophos-Es-Snmp ``` -Be sure to have with you the following information: + + - - Read-Only SNMP community - - IP Address of the equipment +## Utiliser le connecteur de supervision -### Configure SNMP on your server +### Utiliser un modèle d'hôte issu du connecteur -Follow constructor procedure for your equipment. +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-Sophos-Es-SNMP-custom**. -### SNMP Permissions +> 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). -Read-Only access. +| 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). | | | -### Troubleshooting +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. -Read [Troubleshooting -SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#troubleshooting-snmp). +### Utiliser un modèle de service issu du connecteur -## Centreon Configuration +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. -### Create a host using the appropriate template + + -Go to *Configuration \> Hosts* and click *Add*. Then, fill the form as shown by -the following table: +| Macro | Description | Valeur par défaut | Obligatoire | +|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check (default: '.*'). Can be: 'component', 'system' | | | +| 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 | +|:--------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERTYPE | Filter message type (can be a regexp) | | | +| WARNINGMSGIN | Warning threshold | | | +| CRITICALMSGIN | Critical threshold | | | +| WARNINGMSGOUT | Warning threshold | | | +| CRITICALMSGOUT | Critical threshold | | | +| WARNINGQUEUE | Warning threshold | | | +| CRITICALQUEUE | Critical threshold | | | +| WARNINGTOTALMSGIN | Warning threshold | | | +| CRITICALTOTALMSGIN | Critical threshold | | | +| WARNINGTOTALMSGOUT | Warning threshold | | | +| CRITICALTOTALMSGOUT | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées [ici](#options-disponibles). | --verbose | | + + + + +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_sophos_es_snmp.pl \ + --plugin=network::sophos::es::snmp::plugin \ + --mode=message \ + --hostname=10.0.0.1 \ + --snmp-version='2c' \ + --snmp-community='my-snmp-community' \ + --filter-type='' \ + --warning-queue='' \ + --critical-queue='' \ + --warning-total-msg-in='' \ + --critical-total-msg-in='' \ + --warning-total-msg-out='' \ + --critical-total-msg-out='' \ + --warning-msg-in='' \ + --critical-msg-in='' \ + --warning-msg-out='' \ + --critical-msg-out='' \ + --verbose +``` + +La commande devrait retourner un message de sortie similaire à : + +```bash +OK: Total Message In : 73/s Total Message Out : 35/s All messages are ok | 'queue'=69;;;0;'total-msg-in'=73/s;;;0;'total-msg-out'=35/s;;;0;'*sea_msg*#msg-in'=73/s;;;0;'*sea_msg*#msg-out'=35/s;;;0; +``` -| Field | Value | -| :----------------------------------- | :------------------------- | -| Host name | *Name of the host* | -| Alias | *Host description* | -| IP | *Host IP Address* | -| Monitored from | *Monitoring Poller to use* | -| Host Multiple Templates | Net-Sophos-Es-SNMP-custom | +### Diagnostic des erreurs communes -Click on the *Save* button. +Rendez-vous sur la [documentation dédiée](../getting-started/how-to-guides/troubleshooting-plugins.md) +pour le diagnostic des erreurs communes des plugins Centreon. + +### Modes disponibles + +Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution +du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est +implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce +modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal. + +Tous les modes disponibles peuvent être affichés en ajoutant le paramètre +`--list-mode` à la commande : + +```bash +/usr/lib/centreon/plugins/centreon_sophos_es_snmp.pl \ + --plugin=network::sophos::es::snmp::plugin \ + --list-mode +``` + +Le plugin apporte les modes suivants : + +| Mode | Modèle de service associé | +|:-----------------------------------------------------------------------------------------------------------------------|:----------------------------------| +| health [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/sophos/es/snmp/mode/health.pm)] | Net-Sophos-Es-Health-SNMP-custom | +| message [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/sophos/es/snmp/mode/message.pm)] | Net-Sophos-Es-Message-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. | +| --verbose | Display extended status information (long output). | +| --debug | Display debug messages. | +| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | +| --filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. | +| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '\_max' suffix). Example: it will split 'used\_prct'=26.93%;0:80;0:90;0;100 into 'used\_prct'=26.93%;0:80;0:90;0;100 'used\_prct\_max'=100%;;;; | +| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[m ax\]\] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard \|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traf fic\_(in\|out)\_$1)' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. | +| --hostname | Name or address of the host to monitor (mandatory). | +| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | +| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | +| --snmp-port | UDP port to send the SNMP request to (default: 161). | +| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | +| --snmp-retries | Maximum number of retries (default: 5). | +| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | +| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | +| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | +| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | +| --snmp-cache-file | Use SNMP cache file. | +| --snmp-username | SNMP v3 only: User name (securityName). | +| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | +| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | +| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | +| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | +| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | +| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | +| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | +| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | +| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | +| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | +| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | + +#### Options des modes + +Les options disponibles pour chaque modèle de services sont listées ci-dessous : + + + + +| Option | Description | +|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'component', 'system'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=system,MailDiskUsage | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='component,UNKNOWN,unknown' | + + + + +| Option | Description | +|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --filter-type | Filter message type (can be a regexp). | +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='queue' | +| --warning-* --critical-* | Thresholds. Can be: queue, total-msg-in, total-msg-out, msg-in, msg-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_sophos_es_snmp.pl \ + --plugin=network::sophos::es::snmp::plugin \ + --mode=message \ + --help +``` diff --git a/pp/integrations/plugin-packs/procedures/network-sophos-es-snmp.md b/pp/integrations/plugin-packs/procedures/network-sophos-es-snmp.md index 480c8a5ff58b..3d3508a6f783 100644 --- a/pp/integrations/plugin-packs/procedures/network-sophos-es-snmp.md +++ b/pp/integrations/plugin-packs/procedures/network-sophos-es-snmp.md @@ -2,48 +2,388 @@ id: network-sophos-es-snmp title: Sophos ES --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Pack assets + +### Templates + +The Monitoring Connector **Sophos ES** brings a host template: + +* **Net-Sophos-Es-SNMP-custom** + +The connector brings the following service templates (sorted by the host template they are attached to): + + + + +| Service Alias | Service Template | Service Description | +|:--------------|:----------------------------------|:-------------------------| +| Health | Net-Sophos-Es-Health-SNMP-custom | Check health status | +| Message | Net-Sophos-Es-Message-SNMP-custom | Check message statistics | + +> The services listed above are created automatically when the **Net-Sophos-Es-SNMP-custom** host template is used. + + + + +### 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-Sophos-Es-SNMP-custom** host template | + +More information about discovering hosts automatically is available on the [dedicated page](/docs/monitoring/discovery/hosts-discovery). + +### Collected metrics & status + +Here is the list of services for this connector, detailing all metrics linked to each service. + + + + +| Metric name | Unit | +| :------------ | :---- | +| status | N/A | + + + + +| Metric name | Unit | +|:------------------|:------| +| queue | N/A | +| total-msg-in | /s | +| total-msg-out | /s | +| *sea_msg*#msg-in | /s | +| *sea_msg*#msg-out | /s | + +> To obtain this new metric format, include **--use-new-perfdata** in the **EXTRAOPTIONS** service macro. + + + ## Prerequisites -### Centreon Plugin +### SNMP Configuration + +The SNMP agent must be configured and activated on the host. Please refer to the official documentation from the manufacturer/publisher. + +### Network flow + +The target resource must be reachable from the Centreon poller on the UDP/161 +SNMP port. + +## Installing the monitoring connector + +### 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: + + + + +```bash +dnf install centreon-pack-network-sophos-es-snmp +``` + + + + +```bash +dnf install centreon-pack-network-sophos-es-snmp +``` + + + + +```bash +apt install centreon-pack-network-sophos-es-snmp +``` + + + + +```bash +yum install centreon-pack-network-sophos-es-snmp +``` + + + + +2. Whatever the license type (*online* or *offline*), install the **Sophos ES** connector through +the **Configuration > Monitoring Connector Manager** menu. + +### Plugin + +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 -Install this plugin on each needed poller: +> More information in the [Installing the plugin](/docs/monitoring/pluginpacks/#installing-the-plugin) section. -``` shell +Use the commands below according to your operating system's package manager: + + + + +```bash +dnf install centreon-plugin-Network-Sophos-Es-Snmp +``` + + + + +```bash +dnf install centreon-plugin-Network-Sophos-Es-Snmp +``` + + + + +```bash +apt install centreon-plugin-network-sophos-es-snmp +``` + + + + +```bash yum install centreon-plugin-Network-Sophos-Es-Snmp ``` -Be sure to have with you the following information: + + + +## Using the monitoring connector + +### Using a host template provided by the connector + +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-Sophos-Es-SNMP-custom** template to the host. + +> When using SNMP v3, use the **SNMPEXTRAOPTIONS** macro to add specific authentication parameters. +> More information in the [Troubleshooting SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#snmpv3-options-mapping) section. + +| Macro | Description | Default value | Mandatory | +|:-----------------|:-----------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| SNMPEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). All options are listed [here](#available-options). | | | + +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). + + + + +| Macro | Description | Default value | Mandatory | +|:-------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| COMPONENT | Which component to check (default: '.*'). Can be: 'component', 'system' | | | +| 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 | | + + + - - Read-Only SNMP community - - IP Address of the equipment +| Macro | Description | Default value | Mandatory | +|:--------------------|:---------------------------------------------------------------------------------------------------|:------------------|:-----------:| +| FILTERTYPE | Filter message type (can be a regexp) | | | +| WARNINGMSGIN | Warning threshold | | | +| CRITICALMSGIN | Critical threshold | | | +| WARNINGMSGOUT | Warning threshold | | | +| CRITICALMSGOUT | Critical threshold | | | +| WARNINGQUEUE | Warning threshold | | | +| CRITICALQUEUE | Critical threshold | | | +| WARNINGTOTALMSGIN | Warning threshold | | | +| CRITICALTOTALMSGIN | Critical threshold | | | +| WARNINGTOTALMSGOUT | Warning threshold | | | +| CRITICALTOTALMSGOUT | Critical threshold | | | +| EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). All options are listed [here](#available-options). | --verbose | | -### Configure SNMP on your server + + -Follow constructor procedure for your equipment. +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. -### SNMP Permissions +## How to check in the CLI that the configuration is OK and what are the main options for? -Read-Only access. +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_sophos_es_snmp.pl \ + --plugin=network::sophos::es::snmp::plugin \ + --mode=message \ + --hostname=10.0.0.1 \ + --snmp-version='2c' \ + --snmp-community='my-snmp-community' \ + --filter-type='' \ + --warning-queue='' \ + --critical-queue='' \ + --warning-total-msg-in='' \ + --critical-total-msg-in='' \ + --warning-total-msg-out='' \ + --critical-total-msg-out='' \ + --warning-msg-in='' \ + --critical-msg-in='' \ + --warning-msg-out='' \ + --critical-msg-out='' \ + --verbose +``` + +The expected command output is shown below: + +```bash +OK: Total Message In : 73/s Total Message Out : 35/s All messages are ok | 'queue'=69;;;0;'total-msg-in'=73/s;;;0;'total-msg-out'=35/s;;;0;'*sea_msg*#msg-in'=73/s;;;0;'*sea_msg*#msg-out'=35/s;;;0; +``` ### Troubleshooting -Read [Troubleshooting -SNMP](../getting-started/how-to-guides/troubleshooting-plugins.md#troubleshooting-snmp). +Please find the [troubleshooting documentation](../getting-started/how-to-guides/troubleshooting-plugins.md) +for Centreon Plugins typical issues. + +### Available modes + +In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. +In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. +However, you will need to specify the correct mode for the template if you want to test the execution command for the +connector in your terminal. + +All available modes can be displayed by adding the `--list-mode` parameter to +the command: + +```bash +/usr/lib/centreon/plugins/centreon_sophos_es_snmp.pl \ + --plugin=network::sophos::es::snmp::plugin \ + --list-mode +``` + +The plugin brings the following modes: -## Centreon Configuration +| Mode | Linked service template | +|:-----------------------------------------------------------------------------------------------------------------------|:----------------------------------| +| health [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/sophos/es/snmp/mode/health.pm)] | Net-Sophos-Es-Health-SNMP-custom | +| message [[code](https://github.com/centreon/centreon-plugins/blob/develop/src/network/sophos/es/snmp/mode/message.pm)] | Net-Sophos-Es-Message-SNMP-custom | -### Create a host using the appropriate template +### Available options -Go to *Configuration \> Hosts* and click *Add*. Then, fill the form as shown by -the following table: +#### Generic options -| Field | Value | -| :----------------------------------- | :------------------------- | -| Host name | *Name of the host* | -| Alias | *Host description* | -| IP | *Host IP Address* | -| Monitored from | *Monitoring Poller to use* | -| Host Multiple Templates | Net-Sophos-Es-SNMP-custom | +All generic options are listed here: -Click on the *Save* button. +| Option | Description | +|:-------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --mode | Define the mode in which you want the plugin to be executed (see--list-mode). | +| --dyn-mode | Specify a mode with the module's path (advanced). | +| --list-mode | List all available modes. | +| --mode-version | Check minimal version of mode. If not, unknown error. | +| --version | Return the version of the plugin. | +| --pass-manager | Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass. | +| --verbose | Display extended status information (long output). | +| --debug | Display debug messages. | +| --filter-perfdata | Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data. | +| --filter-perfdata-adv | Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value. | +| --explode-perfdata-max | Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '\_max' suffix). Example: it will split 'used\_prct'=26.93%;0:80;0:90;0;100 into 'used\_prct'=26.93%;0:80;0:90;0;100 'used\_prct\_max'=100%;;;; | +| --change-perfdata --extend-perfdata | Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target\[,\[newuom\],\[min\],\[m ax\]\] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic\_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic\_in,,percent()' | +| --extend-perfdata-group | Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation\[,\[ne wuom\],\[min\],\[max\]\] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets\_wrong,sum(packets\_(discard \|error)\_(in\|out))' Sum traffic by interface: --extend-perfdata-group='traffic\_in\_(.*),traffic\_$1,sum(traf fic\_(in\|out)\_$1)' | +| --change-short-output --change-long-output | Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up' | +| --change-exit | Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state. | +| --range-perfdata | Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata. | +| --filter-uom | Mask the units when they don't match the given regular expression. | +| --opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown. | +| --output-ignore-perfdata | Remove all the metrics from the service. The service will still have a status and an output. | +| --output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...' | +| --output-xml | Return the output in XML format (to send to an XML API). | +| --output-json | Return the output in JSON format (to send to a JSON API). | +| --output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting this format). | +| --output-file | Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt. | +| --disco-format | Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML). | +| --disco-show | Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery. | +| --float-precision | Define the float precision for thresholds (default: 8). | +| --source-encoding | Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'. | +| --hostname | Name or address of the host to monitor (mandatory). | +| --snmp-community | SNMP community (default value: public). It is recommended to use a read-only community. | +| --snmp-version | Version of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3. | +| --snmp-port | UDP port to send the SNMP request to (default: 161). | +| --snmp-timeout | Time to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries. | +| --snmp-retries | Maximum number of retries (default: 5). | +| --maxrepetitions | Max repetitions value (default: 50) (only for SNMP v2 and v3). | +| --subsetleef | How many OID values per SNMP request (default: 50) (for get\_leef method. Be cautious when you set it. Prefer to let the default value). | +| --snmp-autoreduce | Progressively reduce the number of requested OIDs in bulk mode. Use it in case of SNMP errors (by default, the number is divided by 2). | +| --snmp-force-getnext | Use SNMP getnext function in SNMP v2c and v3. This will request one OID at a time. | +| --snmp-cache-file | Use SNMP cache file. | +| --snmp-username | SNMP v3 only: User name (securityName). | +| --authpassphrase | SNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option. | +| --authprotocol | SNMP v3 only: Authentication protocol: MD5\|SHA. Since net-snmp 5.9.1: SHA224\|SHA256\|SHA384\|SHA512. | +| --privpassphrase | SNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option. | +| --privprotocol | SNMP v3 only: Privacy protocol (privProtocol) used to encrypt messages. Supported protocols are: DES\|AES and since net-snmp 5.9.1: AES192\|AES192C\|AES256\|AES256C. | +| --contextname | SNMP v3 only: Context name (contextName), if relevant for the monitored host. | +| --contextengineid | SNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string. | +| --securityengineid | SNMP v3 only: Security engine ID, given as a hexadecimal string. | +| --snmp-errors-exit | Expected status in case of SNMP error or timeout. Possible values are warning, critical and unknown (default). | +| --snmp-tls-transport | Transport protocol for TLS communication (can be: 'dtlsudp', 'tlstcp'). | +| --snmp-tls-our-identity | X.509 certificate to identify ourselves. Can be the path to the certificate file or its contents. | +| --snmp-tls-their-identity | X.509 certificate to identify the remote host. Can be the path to the certificate file or its contents. This option is unnecessary if the certificate is already trusted by your system. | +| --snmp-tls-their-hostname | Common Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter. | +| --snmp-tls-trust-cert | A trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname. | + +#### Modes options + +All available options for each service template are listed below: + + + + +| Option | Description | +|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --component | Which component to check (default: '.*'). Can be: 'component', 'system'. | +| --filter | Exclude some parts (comma separated list) You can also exclude items from specific instances: --filter=system,MailDiskUsage | +| --no-component | Define the expected status if no components are found (default: critical). | +| --threshold-overload | Use this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,\[instance,\]status,regexp). Example: --threshold-overload='component,UNKNOWN,unknown' | + + + + +| Option | Description | +|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| --memcached | Memcached server to use (only one server). | +| --redis-server | Redis server to use (only one server). Syntax: address\[:port\] | +| --redis-attribute | Set Redis Options (--redis-attribute="cnx\_timeout=5"). | +| --redis-db | Set Redis database index. | +| --failback-file | Fall back on a local file if Redis connection fails. | +| --memexpiration | Time to keep data in seconds (default: 86400). | +| --statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). | +| --statefile-suffix | Define a suffix to customize the statefile name (default: ''). | +| --statefile-concat-cwd | If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux. | +| --statefile-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). | +| --statefile-key | Define the key to encrypt/decrypt the cache. | +| --statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). | +| --filter-type | Filter message type (can be a regexp). | +| --filter-counters | Only display some counters (regexp can be used). Example: --filter-counters='queue' | +| --warning-* --critical-* | Thresholds. Can be: queue, total-msg-in, total-msg-out, msg-in, msg-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_sophos_es_snmp.pl \ + --plugin=network::sophos::es::snmp::plugin \ + --mode=message \ + --help +```