Aller au contenu principal

Keysight NVOS Rest API

Contenu du pack​

Modèles​

Le connecteur de supervision Keysight NVOS Rest API apporte un modèle d'hôte :

  • Net-Keysight-Nvos-Restapi-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
HardwareNet-Keysight-Nvos-Hardware-RestapiContrôle l'état du matériel
TimeNet-Keysight-Nvos-Time-RestapiContrôle le décalage de temps
UptimeNet-Keysight-Nvos-Uptime-RestapiDurée depuis laquelle l'équipement tourne sans interruption

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

Règles de découverte​

Découverte de service​

Nom de la règleDescription
Net-Keysight-Nvos-Restapi-Dynamic-Filter-NameDécouvre les filtres dynamiques et supervise l'utilisation
Net-Keysight-Nvos-Restapi-Port-NameDécouvre les ports et supervise le statut et l'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 rattachées à chaque service.

MétriqueUnité
df~dynamic_filter.traffic.pass.bytespersecondB/s
df~dynamic_filter.traffic.insp.bytespersecondB/s
df~dynamic_filter.packets.denied.countcount
df~dynamic_filter.packets.pass.countcount
df~dynamic_filter.packets.insp.countcount

Prérequis​

Pour la supervision, un utilisateur avec des droits de lecture sur l'Automation API Control-M est nécessaire.

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-keysight-nvos-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Keysight NVOS Rest API 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-Keysight-Nvos-Restapi

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-Keysight-Nvos-Restapi-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
MacroDescriptionValeur par défautObligatoire
KEYSIGHTNVOSAPIPASSWORDAPI password
KEYSIGHTNVOSAPIPORTPort used8000
KEYSIGHTNVOSAPIPROTOSpecify https if neededhttps
KEYSIGHTNVOSAPIUSERNAMEAPI username
KEYSIGHTNVOSAPIEXTRAOPTIONSAny 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
FILTERNAMEFilter dynamic filters by name (can be a regexp)
WARNINGPACKETSDENIED
CRITICALPACKETSDENIED
WARNINGPACKETSINSPThresholds
CRITICALPACKETSINSPThresholds
WARNINGPACKETSPASSThresholds
CRITICALPACKETSPASSThresholds
WARNINGTRAFFICINSP
CRITICALTRAFFICINSP
WARNINGTRAFFICPASS
CRITICALTRAFFICPASS
EXTRAOPTIONSAny extra option you may want to add to the command (E.g. a --verbose flag). Tous les options sont listées ici--verbose
  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_keysight_nvos_restapi.pl \
    --plugin=network::keysight::nvos::restapi::plugin \
    --mode=hardware \
    --hostname='10.0.0.1' \
    --proto='https' \
    --port='8000' \
    --api-username='username' \
    --api-password='*****'  \
    --verbose

La commande devrait retourner un message de sortie similaire à :

OK: temperature 'MAIN' status: normal, reading: 40 C - all power supplies are ok | 'MAIN#hardware.temperature.celsius'=40C;;;;
temperature 'MAIN' status: normal, reading: 40 C
power supply 'power_module_a' status: good
power supply 'power_module_b' status: good

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.

Modes disponibles​

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

/usr/lib/centreon/plugins/centreon_keysight_nvos_restapi.pl \
    --plugin=network::keysight::nvos::restapi::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
dynamic-filtersNet-Keysight-Nvos-Dynamic-Filters-Restapi
hardwareNet-Keysight-Nvos-Hardware-Restapi
list-dynamic-filtersUsed for service discovery
list-portsUsed for service discovery
portsNet-Keysight-Nvos-Ports-Restapi
timeNet-Keysight-Nvos-Time-Restapi
uptimeNet-Keysight-Nvos-Uptime-Restapi

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
--custommodeWhen a plugin offers several ways (CLI, library, etc.) to get the an information the desired one must be defined with this option.Global
--list-custommodeList all available custom modes.Global
--multipleMultiple custom mode objects. This may be required by some specific modes (advanced).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=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OK~Up~gi' 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'). Keysight NVOS APIOutput
--hostnameSet hostname.Api
--portPort used (Default: 8000)Api
--protoSpecify https if needed (Default: 'https')Api
--api-usernameAPI username.Api
--api-passwordAPI password.Api
--timeoutSet timeout in seconds (Default: 50).Api
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.Http global
--proxyurlProxy URLHttp global
--proxypacProxy pac file (can be a URL or local file)Http global
--insecureInsecure SSL connections.Http global
--http-backendSet the backend used (Default: 'lwp') For curl: --http-backend=curlHttp global
--ssl-optSet SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").Backend lwp
--curl-optSet CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).Backend curl

Options des modes​

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

OptionDescriptionType
--memcachedMemcached server to use (only one server).Retention
--redis-serverRedis server to use (only one server). Syntax: address[:port]Retention
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").Retention
--redis-dbSet Redis database index.Retention
--failback-fileFailback on a local file if redis connection failed.Retention
--memexpirationTime to keep data in seconds (Default: 86400).Retention
--statefile-dirDirectory for statefile (Default: '/var/lib/centreon/centplugins').Retention
--statefile-suffixAdd a suffix for the statefile name (Default: '').Retention
--statefile-concat-cwdConcat current working directory with option '--statefile-dir'. Useful on Windows when plugin is compiled.Retention
--statefile-formatFormat used to store cache (can be: 'dumper', 'storable', 'json').Retention
--statefile-keyKey to encrypt/decrypt cache.Retention
--statefile-cipherCipher to encrypt cache (Default: 'AES').Retention
--filter-nameFilter dynamic filters by name (can be a regexp).Mode
--warning- --critical-Thresholds. Can be: 'traffic-out-prct', 'traffic-out', 'packets-out', 'packets-dropped', 'packets-pass', 'packets-insp'.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_keysight_nvos_restapi.pl \
    --plugin=network::keysight::nvos::restapi::plugin \
    --mode=dynamic-filters \
    --help