Aller au contenu principal

Ubiquiti AirFiber SNMP

Dépendances du connecteur de supervision​

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

Contenu du pack​

Modèles​

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

  • Net-Ubiquiti-Airfiber-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) :

AliasModèle de serviceDescription
LoadNet-Ubiquiti-Airfiber-Load-SNMP-customContrôle la charge moyenne
MemoryNet-Ubiquiti-Airfiber-Memory-SNMP-customContrôle la mémoire

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

Règles de découverte​

Découverte d'hôtes​

Nom de la règleDescription
SNMP AgentsDécouvre les ressources via un scan réseau SNMP. Installez le connecteur Generic SNMP pour obtenir la règle de découverte et créez un modificateur pour le modèle d'hôte Net-Ubiquiti-Airfiber-SNMP-custom.

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
Net-Ubiquiti-Airfiber-SNMP-Interface-NameDécouvre les interfaces réseau en utilisant leur nom et supervise leur statut et leur utilisation
Net-Ubiquiti-Airfiber-SNMP-Radio-NameDécouvre les interfaces radio et supervise leur statut ainsi que leur utilisation

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.

NomUnité
statusN/A
interface_name#interface.traffic.in.bitspersecondb/s
interface_name#interface.traffic.out.bitspersecondb/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%

Prérequis​

Configuration SNMP​

Le service 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 :
dnf install centreon-pack-network-ubiquiti-airfiber-snmp
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Ubiquiti AirFiber 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-Ubiquiti-Airfiber-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-Ubiquiti-Airfiber-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 (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
OIDFILTERDefine the OID to be used to filter interfaces (values: ifDesc, ifAlias, ifName, IpAddr)ifname
OIDDISPLAYDefine the OID that will be used to name the interfaces (values: ifDesc, ifAlias, ifName, IpAddr)ifname
INTERFACENAMEDefine 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
WARNINGINDISCARDThreshold
CRITICALINDISCARDThreshold
WARNINGINERRORThreshold
CRITICALINERRORThreshold
WARNINGINTRAFFICThreshold
CRITICALINTRAFFICThreshold
WARNINGOUTDISCARDThreshold
CRITICALOUTDISCARDThreshold
WARNINGOUTERRORThreshold
CRITICALOUTERRORThreshold
WARNINGOUTTRAFFICThreshold
CRITICALOUTTRAFFICThreshold
CRITICALSTATUSDefine 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/
WARNINGSTATUSDefine the conditions to match for the status to be WARNING. You can use the following variables: %{admstatus}, %{opstatus}, %{duplexstatus}, %{display}
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.--verbose --no-skipped-counters --use-new-perfdata
  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_ubiquiti_airfiber_snmp.pl \
	--plugin=network::ubiquiti::airfiber::snmp::plugin \
	--mode=load \
	--hostname=10.0.0.1 \
	--snmp-version='2c' \
	--snmp-community='my-snmp-community'  \
	--warning-load1='' \
	--critical-load1='' \
	--warning-load5='' \
	--critical-load5='' \
	--warning-load15='' \
	--critical-load15=''

La commande devrait retourner un message de sortie similaire à :

OK: 69537 (1m) 16781 (5m) 10110 (15m) | 'system.loadaverage.1m.count'=69537;;;0; 'system.loadaverage.5m.count'=16781;;;0; 'system.loadaverage.15m.count'=10110;;;0;

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_ubiquiti_airfiber_snmp.pl \
	--plugin=network::ubiquiti::airfiber::snmp::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
interfaces [code]Net-Ubiquiti-Airfiber-Interfaces-SNMP-custom
list-interfaces [code]Used for service discovery
list-radios [code]Used for service discovery
load [code]Net-Ubiquiti-Airfiber-Load-SNMP-custom
memory [code]Net-Ubiquiti-Airfiber-Memory-SNMP-custom
radios [code]Net-Ubiquiti-Airfiber-Radios-SNMP-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 getnext 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 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.
--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[,[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-perfdataChange 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-perfdataChange 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-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,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-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.
--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). E.g.: --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'. =head1 DESCRIPTION B<output>. =cut
--filter-countersOnly 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 :

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').
--add-globalCheck global port statistics (by default if no --add-* option is set).
--add-statusCheck interface status.
--add-duplex-statusCheck duplex status (with --warning-status and --critical-status).
--add-trafficCheck interface traffic.
--add-errorsCheck interface errors.
--add-castCheck interface cast.
--add-speedCheck interface speed.
--add-volumeCheck interface data volume between two checks (not supposed to be graphed, useful for BI reporting).
--check-metricsIf the expression is true, metrics are checked (default: '%{opstatus} eq "up"').
--warning-statusDefine the conditions to match for the status to be WARNING. You can use the following variables: %{admstatus}, %{opstatus}, %{duplexstatus}, %{display}
--critical-statusDefine 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-trafficUnits of thresholds for the traffic (default: 'percent_delta') ('percent_delta', 'bps', 'counter').
--units-errorsUnits of thresholds for errors/discards (default: 'percent_delta') ('percent_delta', 'percent', 'delta', 'deltaps', 'counter').
--units-castUnits of thresholds for communication types (default: 'percent_delta') ('percent_delta', 'percent', 'delta', 'deltaps', 'counter').
--nagvis-perfdataDisplay traffic perfdata to be compatible with NagVis widget.
--interfaceDefine 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.
--nameWith 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-idWith this option, interface IDs will be filtered using the --interface parameter as a regular expression instead of a list of IDs.
--speedSet interface speed for incoming/outgoing traffic (in Mb).
--speed-inSet interface speed for incoming traffic (in Mb).
--speed-outSet interface speed for outgoing traffic (in Mb).
--map-speed-dslGet 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-counters64Force to use 64 bits counters only. Can be used to improve performance.
--force-counters32Force to use 32-bits counters (even with SNMP versions 2c and 3). To use when 64 bits counters are buggy.
--reload-cache-timeTime in minutes before reloading cache file (default: 180).
--oid-filterDefine the OID to be used to filter interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr).
--oid-displayDefine the OID that will be used to name the interfaces (default: ifName) (values: ifDesc, ifAlias, ifName, IpAddr).
--oid-extra-displayAdd an OID to display.
--display-transform-src --display-transform-dstModify 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-cacheDisplay cache interface data.

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_ubiquiti_airfiber_snmp.pl \
	--plugin=network::ubiquiti::airfiber::snmp::plugin \
	--mode=load \
	--help