Aller au contenu principal

HMS Netbiter Argos RestAPI

Contenu du Pack​

Modèles​

Le connecteur de supervision Centreon HMS Netbiter Argos RestAPI apporte un modèle d'hôte :

  • HW-Device-Hms-Netbiter-Argos-Restapi-custom

Il apporte les modèles de service suivants :

AliasModèle de serviceDescriptionDéfautDécouverte
AlarmsHW-Device-Hms-Netbiter-Argos-Alarms-RestapiContrôle les alarmes du systèmeX
Sensors-GlobalHW-Device-Hms-Netbiter-Argos-Sensors-Global-RestapiContrôle les sondesX

Les services par Défaut sont créés automatiquement lorsque le modèle d'hôte est appliqué.

Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.

Règles de découverte​

Nom de la règleDescription
Netbiter Argos RestAPI SystemsDiscover HMS/Ewon Netbiter Systems using Argos RestAPI

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

Métriques & statuts collectés​

MétriqueUnité
alarm.duration.secondss
alarms.total.countcount
alarm-activeN/A
alarm-ackedN/A
alarm-severityN/A

Installation​

Pack de supervision​

Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le pack 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-hardware-devices-hms-netbiter-argos-restapi

Quel que soit le type de la licence (online ou offline), installez le Pack HMS Netbiter Argos RestAPI 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 pack. 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-Hardware-Devices-Hms-Netbiter-Argos-Restapi

Configuration​

Hôte​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom & Alias correspondant à votre ressource.
  3. Indiquez le FQDN de l'API Netbiter (généralement api.netbiter.net) dans le champ IP Address/DNS.
  4. Appliquez le modèle d'hôte HW-Device-Hms-Netbiter-Argos-Restapi-custom-custom.
  5. Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
ObligatoireMacroDescriptionDéfaut
APIACCESSKEYFor Access Key "direct" authentication method. Example: --access-key='ABCDEFG1234567890'
APIPASSWORDFor Username/Password authentication method. Must be used with --api-password option
XAPIPORTPort used443
XAPIPROTOSpecify https if neededhttps
APIUSERNAMEFor Username/Password authentication method. Must be used with --api-password option
PROXYURLProxy URL
XSYSTEMIDSet the Netbiter Argos System ID
EXTRAOPTIONSAny extra option you may want to add to every command line (eg. a --verbose flag)

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) :

/usr/lib/centreon/plugins/centreon_hms_netbiter_argos_restapi.pl \
    --plugin=hardware::devices::hms::netbiter::argos::restapi::plugin \
    --mode=alarms \
    --hostname='api.netbiter.net' \
    --port='443' \
    --proto='https' \
    --proxyurl='' \
    --access-key='ABCDEFG1234567890' \
    --system-id='XYZ123'  \
    --warning-alarms-total='1' \
    --critical-alarms-total='2'

La commande devrait retourner un message de sortie similaire à :

OK: Alarms: total current: 0 | 'alarms.total.count'=0;;;0 ;;;;;

Modes disponibles​

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

/usr/lib/centreon/plugins//centreon_hms_netbiter_argos_restapi.pl \
    --plugin=hardware::devices::hms::netbiter::argos::restapi::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
alarmsHW-Device-Hms-Netbiter-Argos-Alarms-Restapi
discoveryNot used in this Plugin Pack
list-sensorsUsed for service discovery
sensorsHW-Device-Hms-Netbiter-Argos-Sensors-Global-Restapi

Options complémentaires​

Options globales​

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

OptionDescriptionType
--modeChoose a mode.Global
--dyn-modeSpecify a mode with the path (separated by '::').Global
--list-modeList available modes.Global
--mode-versionCheck minimal version of mode. If not, unknown error.Global
--versionDisplay plugin version.Global
--custommodeChoose a custom mode.Global
--list-custommodeList available custom modes.Global
--multipleMultiple custom mode objects (required by some specific modes)Global
--pass-managerUse a password manager.Global
--verboseDisplay long output.Output
--debugDisplay also debug messages.Output
--filter-perfdataFilter perfdata that match the regexp.Output
--filter-perfdata-advAdvanced perfdata filter. Eg: --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")'Output
--explode-perfdata-maxPut max perfdata (if it exist) in a specific perfdata (without values: same with '_max' suffix) (Multiple options)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-outputChange short/long output display: --change-short-output=pattern~replace~modifierOutput
--change-exitChange exit code: --change-exit=unknown=criticalOutput
--range-perfdataChange perfdata range thresholds display: 1 = start value equals to '0' is removed, 2 = threshold range is not display.Output
--filter-uomFilter UOM that match the regexp.Output
--opt-exitOptional exit code for an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc) (Default: unknown).Output
--output-ignore-perfdataRemove perfdata from output.Output
--output-ignore-labelRemove label status from output.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 case. Default: 'UTF-8'). Netbiter Argos RestAPIOutput
--hostnameArgos API hostname (Default: api.netbiter.net).Api
--portPort used (Default: 443)Api
--protoSpecify https if needed (Default: 'https')Api
--api-endpointArgos API requests endpoint (Default: '/operation/v1/rest/json')Api
--access-keyFor Access Key "direct" authentication method. Example: --access-key='ABCDEFG1234567890'Api
--api-usernameFor Username/Password authentication method. Must be used with --api-password option.Api
--api-passwordFor Username/Password authentication method. Must be used with --api-username option.Api
--timeoutSet timeout in seconds (Default: 10).Api
--http-peer-addrSet the address you want to connect (Useful if hostname is only a vhost. no ip resolve)Http global
--proxyurlProxy URLHttp global
--proxypacProxy pac file (can be an 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
--sslSet SSL version (=TLSv1).Backend lwp
--curl-optSet CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).Backend curl
--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

Options des modes​

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

OptionDescriptionType
--filter-activeOnly show active alarms.Mode
--system-idSet the Netbiter Argos System ID (Mandatory).Mode
--filter-ackedHide acknowledged alarms.Mode
--filter-activeOnly show active alarms.Mode
--filter-severityOnly show alarms with a given severity level. Can be: 'critical', 'major', 'minor', 'warning', 'cleared'. Only one value can be set (no multiple values).Mode
--warning-active-statusSet warning threshold for active status (Default: ''). Typical syntax: --warning-active-status='%{active} =~ "true"'Mode
--critical-active-statusSet critical threshold for active status (Default: '%{active} =~ "true"'). Typical syntax: --critical-active-status='%{active} =~ "true"'Mode
--warning-acked-statusSet warning threshold for acked status (Default: '%{acked} =~ "false"'). Typical syntax: --warning-acked-status='%{acked} =~ "false"'Mode
--critical-acked-statusSet critical threshold for acked status (Default: ''). Typical syntax: --critical-acked-status='%{acked} =~ "false"'Mode
--warning- --critical-Thresholds. Can be: 'warning-alarms-total' (count) 'critical-alarms-total' (count), 'warning-alarm-duration' (s), 'critical-alarm-duration' (s), 'warning-alarm-severity' (level from 0 to 5), critical-alarm-severity (level from 0 to 5).Mode

Pour un mode, la liste de toutes les options complémentaires et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins//centreon_hms_netbiter_argos_restapi.pl \
    --plugin=hardware::devices::hms::netbiter::argos::restapi::plugin \
    --mode=alarms \
    --help

Diagnostic des erreurs communes​

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