Aller au contenu principal

Cambium CnPilot SNMP

Contenu du pack​

Modèles​

Le connecteur de supervision Cambium cnPilot SNMP apporte un modèle d'hôte :

  • Net-Cambium-cnPilot-SNMP

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

AliasModèle de serviceDescription
Connection statusNet-Cambium-Cnpilot-Connection-status-SNMPContrôle les status de connection
CpuNet-Cambium-Cnpilot-Cpu-SNMPContrôle les CPU
MemoryNet-Cambium-Cnpilot-Memory-SNMPContrôle les mémoires

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte Net-Cambium-cnPilot-SNMP est utilisé.

Règles de découverte​

Découverte de service​

Nom de la règleDescription
Net-Cambium-Cnpilot-SNMP-Interfaces-NameDécouverte des interfaces réseau et supervision de l'utilisation de la bande passante
Net-Cambium-Cnpilot-SNMP-Radios-NameDécouverte des radios

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 rattachées à chaque service.

MétriqueUnité
connection#connection-statusN/A

Prérequis​

Configuration SNMP​

Afin de superviser votre ressource en SNMP, il est nécessaire de configurer l'agent sur le serveur comme indiqué sur la documentation officielle :

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​

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquets 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 paquet associé à sa distribution :
dnf install centreon-pack-network-cambium-cnpilot-snmp
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Cambium cnPilot 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.

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

dnf install centreon-plugin-Network-Cambium-cnPilot-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 Net-Cambium-cnPilot-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.

MacroDescriptionValeur par défautObligatoire
SNMPEXTRAOPTIONSAny extra option you may want to add to every command (E.g. a --verbose flag). Tous 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
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). Tous 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 un serveur en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins//centreon_cambium_cnpilot.pl \
	--plugin=network::cambium::cnpilot::snmp::plugin \
	--mode=interfaces \
	--hostname='10.0.0.1' \
	--snmp-version='2c' \
	--snmp-community='my-snmp-community'  \
	--interface='' \
	--name \
	--add-status \
	--add-traffic \
	--add-errors \
	--warning-status='' \
	--critical-status='%\{admstatus\} eq "up" and %\{opstatus\} !~ /up|dormant/' \
	--warning-in-traffic='' \
	--critical-in-traffic='' \
	--warning-out-traffic='' \
	--critical-out-traffic='' \
	--warning-in-discard='' \
	--critical-in-discard='' \
	--warning-out-discard='' \
	--critical-out-discard='' \
	--warning-in-error='' \
	--critical-in-error='' \
	--warning-out-error='' \
	--critical-out-error='' \
	--oid-filter='ifname' \
	--oid-display='ifname' \

La commande devrait retourner un message de sortie similaire à :

OK: Traffic In : 321.02b/s (-) Traffic Out : 382.02b/s (-) | 'interface.traffic.in.bitspersecond'=59b/s;;;0; 'interface.traffic.out.bitspersecond'=18b/s;;;0;

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.

Modes disponibles​

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins//centreon_cambium_cnpilot.pl \
	--plugin=network::cambium::cnpilot::snmp::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
connection-statusNet-Cambium-Cnpilot-Connection-status-SNMP
cpuNet-Cambium-Cnpilot-Cpu-SNMP
interfacesNet-Cambium-Cnpilot-Interfaces-SNMP
list-interfacesUsed for service discovery
list-radiosUsed for service discovery
memoryNet-Cambium-Cnpilot-Memory-SNMP
radiosNet-Cambium-Cnpilot-Radios-SNMP

Options disponibles​

Options génériques​

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

OptionDescriptionType
--modeDefine the mode in which you want the plugin to be executed (see--list-mode).Global
--dyn-modeSpecify a mode with the module's path (advanced).Global
--list-modeList all available modes.Global
--mode-versionCheck minimal version of mode. If not, unknown error.Global
--versionDisplay the plugin's version.Global
--pass-managerDefine the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.Global
--verboseDisplay extended status information (long output).Output
--debugDisplay debug messages.Output
--filter-perfdataFilter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.Output
--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). Eg: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.Output
--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). Eg: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;Output
--change-perfdata --extend-perfdataChange or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Change storage free perfdata in used: --change-perfdata=free,used,invert() Change storage free perfdata in used: --change-perfdata=used,free,invert() Scale traffic values automaticaly: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic_in,,percent()Output
--extend-perfdata-groupExtend perfdata from multiple perfdatas (methods in target are: min, max, average, sum) Syntax: --extend-perfdata-group=searchlabel,newlabel,target[,[newuom],[m in],[max]] Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'Output
--change-short-output --change-long-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). Eg: adding --change-short-output='OKUpgi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'Output
--change-exitReplace an exit code with one of your choice. Eg: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.Output
--range-perfdataChange perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display.Output
--filter-uomMasks the units when they don't match the given regular expression.Output
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.Output
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a status and an output.Output
--output-ignore-labelRemove the status label from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'Output
--output-xmlDisplay output in XML format.Output
--output-jsonDisplay output in JSON format.Output
--output-openmetricsDisplay metrics in OpenMetrics format.Output
--output-fileWrite output in file (can be used with json and xml options)Output
--disco-formatDisplay discovery arguments (if the mode manages it).Output
--disco-showDisplay discovery values (if the mode manages it).Output
--float-precisionSet the float precision for thresholds (default: 8).Output
--source-encodingSet encoding of monitoring sources (in some cases. Default: 'UTF-8').Output
--hostnameHostname to query (required).SNMP
--snmp-communityRead community (defaults to public).SNMP
--snmp-versionVersion: 1 for SNMP v1 (default), 2 for SNMP v2c, 3 for SNMP v3.SNMP
--snmp-portPort (default: 161).SNMP
--snmp-timeoutTimeout in secondes (default: 1) before retries.SNMP
--snmp-retriesSet the number of retries (default: 5) before failure.SNMP
--maxrepetitionsMax repetitions value (default: 50) (only for SNMP v2 and v3).SNMP
--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
--snmp-autoreduceAuto reduce SNMP request size in case of SNMP errors (By default, the divisor is 2).SNMP
--snmp-force-getnextUse snmp getnext function (even in snmp v2c and v3).SNMP
--snmp-usernameSecurity name (only for SNMP v3).SNMP
--authpassphraseAuthentication protocol pass phrase.SNMP
--authprotocolAuthentication protocol: MD5|SHA. Since net-snmp 5.9.1: SHA224|SHA256|SHA384|SHA512.SNMP
--privpassphrasePrivacy protocol pass phraseSNMP
--privprotocolPrivacy protocol: DES|AES. Since net-snmp 5.9.1: AES192|AES192C|AES256|AES256C.SNMP
--contextnameContext nameSNMP
--contextengineidContext engine IDSNMP
--securityengineidSecurity engine IDSNMP
--snmp-errors-exitExit code for SNMP Errors (default: unknown)SNMP
--snmp-tls-transportTLS Transport communication used (can be: 'dtlsudp', 'tlstcp').SNMP
--snmp-tls-our-identityOur X.509 identity to use, which should either be a fingerprint or the filename that holds the certificate.SNMP
--snmp-tls-their-identityThe remote server's identity to connect to, specified as either a fingerprint or a file name. Either this must be specified, or the hostname below along with a trust anchor.SNMP
--snmp-tls-their-hostnameThe remote server's hostname that is expected. If their certificate was signed by a CA then their hostname presented in the certificate must match this value or the connection fails to be established (to avoid man-in-the-middle attacks).SNMP
--snmp-tls-trust-certA trusted certificate to use as trust anchor (like a CA certificate) for verifying a remote server's certificate. If a CA certificate is used to validate a certificate then the TheirHostname parameter must also be specified to ensure their presented hostname in the certificate matches.SNMP

Options des modes​

Les options spécifiques aux modes sont listées ci-dessus :

OptionDescriptionType
--filter-apFilter on one or several AP.Mode
--warning-connection-statusSet warning threshold for status. Can used special variables like: %{status}, %{name}Mode
--critical-connection-statusSet critical threshold for status. Can used special variables like: %{status}, %{name}Mode

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_cambium_cnpilot.pl \
	--plugin=network::cambium::cnpilot::snmp::plugin \
	--mode=interfaces \
    --help