Aller au contenu principal

Generic SNMP

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur Generic SNMP depuis la page Configuration > Connecteurs > Connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision Generic SNMP apporte 2 modèles d'hôte :

  • App-Protocol-SNMP-custom
  • App-Protocol-SNMP-Only-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

Ce modèle d'hôte n'a pas de modèle de service associé.

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
SNMP AgentsDiscover hosts by requesting their SNMP agents
SNMP v3 Agents (deprecated)Discover hosts by requesting their SNMP agents using SNMP v3
SNMP v3 Agents enhancedDiscover SNMP v3 hosts and fill dedicated macros to store their v3 credentials
SNMP IP Addresses (RFC 4293)Discover IP addresses by requesting a SNMP agent (RFC 4293)

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique d'hôtes.

Découverte de services​

Nom de la règleDescription
App-Protocol-SNMP-Collection-NameDécouvre les données SNMP en utilisant des collections

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service.

Pour ce mode spécifique, les noms des métriques dépendront de la configuration effectuée par l'utilisateur.

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. 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 le serveur supervisé.

Installer le connecteur de supervision​

Pack​

La procédure d'installation des connecteurs de supervision diffère légèrement suivant que votre licence est offline ou online.

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Connecteurs > Connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-applications-protocol-snmp
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Generic SNMP depuis l'interface web et le menu Configuration > Connecteurs > Connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un 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.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Applications-Protocol-Snmp

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 App-Protocol-SNMP-custom.
MacroDescriptionValeur par défautObligatoire
SNMPEXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur​

  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 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.
MacroDescriptionValeur par défautObligatoire
FORMATOKThreshold%{filter_rows} value(s)
FORMATUNKNOWNThresholdvalue(s): %{details_unknown}
OIDOID value to check (numeric format only)
WARNINGReturn Warning if an oid value match the regexp
CRITICALReturn Critical if an oid value match the regexp
FORMATWARNINGThresholdvalue(s): %{details_warning}
FORMATCRITICALThresholdvalue(s): %{details_critical}
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la 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) :

/usr/lib/centreon/plugins/centreon_generic_snmp.pl \
	--plugin=apps::protocols::snmp::plugin \
	--mode=response-time \
	--hostname=10.0.0.1 \
	--snmp-community='my-snmp-community' \
	--snmp-version=2c  \
	--warning-rta='' \
	--critical-rta='' \
	--warning-rtmax='' \
	--critical-rtmax='' \
	--warning-rtmin='' \
	--critical-rtmin='' \
	--warning-pl='' \
	--critical-pl=''

La commande devrait retourner un message de sortie similaire à :

OK: rta 91340ms   lost 39097% | 'roundtrip.time.average.milliseconds'=91340ms;;;0; 'roundtrip.time.maximum.milliseconds'=85208ms;;;0; 'roundtrip.time.minimum.milliseconds'=23638ms;;;0; 'packets.loss.percentage'=39097%;;;0;100

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée 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 :

/usr/lib/centreon/plugins/centreon_generic_snmp.pl \
	--plugin=apps::protocols::snmp::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
cache [code]Non utilisé dans ce connecteur de supervision
collection [code]Non utilisé dans ce connecteur de supervision
discovery [code]Utilisé pour la découverte d'hôtes
dynamic-command [code]Non utilisé dans ce connecteur de supervision
numeric-value [code]App-Protocol-SNMP-Numeric-Value-custom
response-time [code]App-Protocol-SNMP-Response-Time-custom
string-value [code]App-Protocol-SNMP-String-Value-custom
uptime [code]App-Protocol-SNMP-Uptime-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see --list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--hostnameName or address of the host to monitor (mandatory).
--snmp-communitySNMP community (default value: public). It is recommended to use a read-only community.
--snmp-versionVersion of the SNMP protocol. 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3.
--snmp-portUDP port to send the SNMP request to (default: 161).
--snmp-timeoutTime to wait before sending the request again if no reply has been received, in seconds (default: 1). See also --snmp-retries.
--snmp-retriesMaximum number of retries (default: 5).
--maxrepetitionsMax repetitions value (default: 50) (only for SNMP v2 and v3).
--subsetleefHow 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-autoreduceProgressively 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-getnextUse SNMP get-next function in SNMP v2c and v3. This will request one OID at a time.
--snmp-cache-fileUse SNMP cache file.
--snmp-usernameSNMP v3 only: User name (securityName).
--authpassphraseSNMP v3 only: Pass phrase hashed using the authentication protocol defined in the --authprotocol option.
--authprotocolSNMP v3 only: Authentication protocol: MD5|SHA. Since net-snmp 5.9.1: SHA224|SHA256|SHA384|SHA512.
--privpassphraseSNMP v3 only: Privacy pass phrase (privPassword) to encrypt messages using the protocol defined in the --privprotocol option.
--privprotocolSNMP 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.
--contextnameSNMP v3 only: Context name (contextName), if relevant for the monitored host.
--contextengineidSNMP v3 only: Context engine ID (contextEngineID), if relevant for the monitored host, given as a hexadecimal string.
--securityengineidSNMP v3 only: Security engine ID, given as a hexadecimal string.
--snmp-errors-exitExpected status in case of SNMP error or timeout. Possible values are ok, warning, critical and unknown (default).
--snmp-tls-transportTransport protocol for TLS communication (can be: dtlsudp, tlstcp).
--snmp-tls-our-identityX.509 certificate to identify ourselves. Can be the path to the certificate file or its contents.
--snmp-tls-their-identityX.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-hostnameCommon Name (CN) expected in the certificate sent by the host if it differs from the value of the --hostname parameter.
--snmp-tls-trust-certA trusted CA certificate used to verify a remote host's certificate. If you use this option, you must also define --snmp-tls-their-hostname.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--show-passwordBy default, sensitive information in command lines is hidden in debug output and replaced with *** (however, debug logs may still display sensitive information). Using the C option will display the passwords in plain text.
--filter-perfdataFilter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-advFilter 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-maxCreate 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-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: onvert 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()'
--change-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: onvert 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-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[<new-unit-of-mesure>],[min],[max]] Common examples: onvert 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-groupAdd 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,<names-of-new-metrics>,calculation[,[<new-unit-of-mesure>],[min],[max]] regex: regular expression <names-of-new-metrics>: 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 <new-unit-of-mesure> (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: um 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)'
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-short-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-long-outputModify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--change-output-advReplace short output and exit code based on a "if" condition using the following variables: short_output, exit_code. Variables must be written either %{variable} or %(variable). Example: adding --change-output-adv='%(short_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result.
--range-perfdataRewrite 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-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting this format).
--output-fileWrite output in file (can be combined with JSON, XML and OpenMetrics options). Example: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-showApplies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resource Default: 'UTF-8'. <output>.

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

OptionDescription
--memcachedMemcached server to use (only one server).
--redis-serverRedis server to use (only one server). Syntax: address[:port]
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").
--redis-dbSet Redis database index.
--failback-fileFall back on a local file if Redis connection fails.
--memexpirationTime to keep data in seconds (default: 86400).
--statefile-dirDefine the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffixDefine a suffix to customize the statefile name (default: '').
--statefile-concat-cwdIf 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-formatDefine the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-keyDefine the key to encrypt/decrypt the cache.
--statefile-cipherDefine the cipher algorithm to encrypt the cache (default: 'AES').
--warningWarning threshold.
--criticalCritical threshold.
--oid-typeType of the OID (default: 'gauge'). Can be 'counter' also. 'counter' will use a retention file.
--counter-per-secondsConvert counter value on a value per seconds (only with type 'counter').
--extracted-patternDefine a pattern to extract a number from the returned string.
--formatOutput format (default: 'current value is %s')
--format-customApply a custom change on the value (example to multiply the value: --format-custom='* 8').
--format-scaleScale bytes value. We'll display value in output.
--format-scale-typeCould be 'network' (value divide by 1000) or 'other' (divide by 1024) (default: 'other') Output format (default: 'current value is %s')
--perfdata-unitPerfdata unit in perfdata output (default: '')
--perfdata-namePerfdata name in perfdata output (default: 'value')
--perfdata-minMinimum value to add in perfdata output (default: '')
--perfdata-maxMaximum value to add in perfdata output (default: '')
--config-jsonJSON format to configure the mode. Can check multiple OID. Example: --config-json='[ { "oid": ".1.3.6.1.2.1.1.3.0", "perfdata_name": "oid1", "format": "current oid1 value is %s"}, { "oid": ".1.3.6.1.2.1.1.3.2", "perfdata_name": "oid2", "format": "current oid2 value is %s"} ]'
--oid --oid-leefOID value to check (numeric format only).
--oid-tableOID table value to check (numeric format only).
--oid-instanceOID table value for the instance (numeric format only). Can be used to have human readable instance name.
--filter-table-valueFilter value from --oid-table option (can be a regexp).
--filter-table-instanceFilter instance from --oid-table option (can be a regexp).
--warning-regexpReturn Warning if an oid value match the regexp.
--critical-regexpReturn Critical if an oid value match the regexp.
--regexp-insensitiveAllows to use regexp non case-sensitive.
--format-*Output format according to the threshold. Can be: 'ok' (default: '%{filter_rows} value(s)'), 'warning' (default: 'value(s): %{details_warning}'), 'critical' (default: 'value(s): %{details_critical}'), 'unknown' (default: 'value(s): %{details_unknown}'). You can use the following variables: %{rows}, %{filter_rows}, %{details_warning}, %{details_ok}, %{details_critical}, %{details_unknown}
--map-valuesUse to transform an integer value in most common case. Example: --map-values='1=>ok,10=>fan failed,11=>psu recovery'
--map-value-otherUse to transform an integer value not defined in --map-values option.
--map-values-separatorSeparator uses between values (default: coma).
--convert-custom-valuesCustom code to convert values. Example to convert octet string to MAC address: --convert-custom-values='join(":", unpack("(H2)*", $value))'
--use-perl-modLoad additional Perl module (can be defined multiple times) Example : --use-perl-mod='Date::Parse'

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 :

/usr/lib/centreon/plugins/centreon_generic_snmp.pl \
	--plugin=apps::protocols::snmp::plugin \
	--mode=response-time \
	--help