Aller au contenu principal

EMC Symmetrix NSClient++ API

Dépendances du connecteur de supervision​

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

Contenu du pack​

Modèles​

Le connecteur de supervision EMC Symmetrix API apporte 2 modèles d'hôte :

  • HW-Storage-EMC-Symmetrix-Dmx34-NSClient-05-Restapi-custom
  • HW-Storage-EMC-Symmetrix-Vmax-NSClient-05-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
Hardware-GlobalHW-Storage-EMC-Symmetrix-Dmx34-Hardware-Global-NSClient05-Restapi-customContrôle permettant de vérifier l'état des composants matériels

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte HW-Storage-EMC-Symmetrix-Dmx34-NSClient-05-Restapi-custom est utilisé.

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é
director.statusN/A
xcm.statusN/A
disk.statusN/A
memory.statusN/A
test.statusN/A
fru.statusN/A
module.statusN/A
temperature.statusN/A
cabling.statusN/A
power.statusN/A
fabric.statusN/A
voltage.statusN/A
spreadisk.statusN/A

Prérequis​

Centreon NSClient++​

Pour superviser une ressource via NSClient++ API, installez la version Centreon de l'agent NSClient++. Veuillez suivre notre documentation officielle et assurez-vous que la configuration du serveur Web / RestAPI est correcte.

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-hardware-storage-emc-symmetrix-nsclient-05-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur EMC Symmetrix API depuis l'interface web et le menu Configuration > Connecteurs > Connecteurs de supervision.

Plugin​

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

dnf install centreon-plugin-Operatingsystems-Windows-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 HW-Storage-EMC-Symmetrix-Dmx34-NSClient-05-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
NSCPRESTAPILEGACYPASSWORDPassword to authenticate against the API if relevantPASSWORD
NSCPRESTAPIPROTONSClient++ RestAPI protocol to usehttps
NSCPRESTAPIPORTNSClient++ RestAPI port8443
NSCPRESTAPIEXTRAOPTIONSAny 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
COMPONENTWhich component to check (default: '.*'). Can be: 'module', 'temperature', 'director, 'cabling', 'power', 'voltage', 'sparedisk'.*
FILEHEALTHName of the global storage file status
FILEHEALTHENVName of the environment storage file status
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes 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 une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_nsclient_restapi.pl \
	--plugin=apps::nsclient::restapi::plugin \
	--mode=query \
	--hostname='10.0.0.1' \
	--port='8443' \
	--proto='https' \
	--legacy-password='PASSWORD'  \
	--command=check_centreon_plugins \
	--arg='storage::emc::symmetrix::vmax::local::plugin' \
	--arg='hardware' \
	--arg=' \
	--file-health="" \
	--file-health-env="" \
	--component=".*" \
	--verbose'

La commande devrait retourner un message de sortie similaire à :

OK: All 2 components are ok [2/2 temperatures]. | 'temp1 Temp'=30C;;;;'temp2 Temp'=31C;;;;'count_temperature'=2;;;;

Diagnostic des erreurs communes​

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

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_nsclient_restapi.pl \
	--plugin=apps::nsclient::restapi::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
hardware [code]HW-Storage-EMC-Symmetrix-Dmx34-Hardware-Global-NSClient05-Restapi-custom
HW-Storage-EMC-Symmetrix-Vmax-Hardware-Global-NSClient05-Restapi-custom

Options disponibles​

Options des modes​

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

OptionDescription
--componentWhich component to check (default: '.*'). Can be: 'module', 'temperature', 'director, 'cabling', 'power', 'voltage', 'sparedisk'.
--filterExclude the items given as a comma-separated list (example: --filter=temperature --filter=module). You can also exclude items from specific instances: --filter=temperature,ES-PWS-A ES-4
--absent-problemReturn an error if a component is not 'present' (default is skipping). It can be set globally or for a specific instance: --absent-problem='component_name' or --absent-problem='component_name,instance_value'.
--no-componentDefine the expected status if no components are found (default: critical).
--threshold-overloadUse this option to override the status returned by the plugin when the status label matches a regular expression (syntax: section,[instance,]status,regexp). Example: --threshold-overload='director,WARNING,^(?!(OK)$)'
--warningSet warning threshold for disk (syntax: type,regexp,threshold) Example: --warning='sparedisk,.*,5:'
--criticalSet critical threshold for disk (syntax: type,regexp,threshold) Example: --critical='sparedisk,.*,3:'
--warning-count-*Define the warning threshold for the number of components of one type (replace '*' with the component type).
--critical-count-*Define the critical threshold for the number of components of one type (replace '*' with the component type).
--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').
--health-directoryLocation of health files.
--health-directory-patternSet pattern to match the most recent directory (getting the hexa value).
--file-health-nameName of the global storage file status (default: HealthCheck.log).
--file-health-env-nameName of the environment storage file status (default: sympl_env_health.log).

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_nsclient_restapi.pl \
	--plugin=apps::nsclient::restapi::plugin \
	--mode=query \
	--help