Aller au contenu principal

Hyper-V NSCP Rest API

Contenu du Pack​

Modèles​

Le Pack Centreon Hyper-V apporte 2 modèles d'hôtes :

  • Virt-Hyperv-Node-Nscp-Restapi-custom
  • Virt-Hyperv-Scvmm-Nscp-Restapi-custom

Il apporte les modèles de service suivants :

Service AliasService TemplateDefaultDiscovery
Node-Integration-ServiceVirt-Hyperv-Node-Integration-Service-Nscp-RestapiX
Node-ReplicationVirt-Hyperv-Node-Replication-Nscp-RestapiX
Node-SnapshotVirt-Hyperv-Node-Snapshot-Nscp-RestapiX
Node-Vm-StatusVirt-Hyperv-Node-Vm-Status-Nscp-RestapiX
Scvmm-Integration-ServiceVirt-Hyperv-Scvmm-Integration-Service-Nscp-RestapiX
Scvmm-SnapshotVirt-Hyperv-Scvmm-Snapshot-Nscp-RestapiX
Scvmm-Vm-StatusVirt-Hyperv-Scvmm-Vm-Status-Nscp-RestapiX

Règles de découverte​

Rule nameDescription
Virt-Hyperv-Nscp-Restapi-HostDiscovery-Scvmm-VmDécouvrez vos machines virtuelles liées à un SCVMM

Métriques & statuts collectés​

Metric nameDescriptionUnit
global statusGlobal status of virtual machines integration services
service statusPrimary and secondary status of each virtual machines services

Prérequis​

NSClient Configuration​

Pour superviser un Hyper-V via NRPE, installez la version packagée Centreon de l'agent NSClient++. Suivez notre documentation officielle

Veuillez télécharger et installer la dernière version en date de Centreon-NSClient-xxx.exe: https://github.com/centreon/centreon-nsclient-build/releases

Par défaut, l'utilisateur centreon avec le mot de passe centreon est utilisé pour se connecter à NSClient.

Flux réseau​

La communication doit être possible sur le port TCP 8443 depuis le collecteur Centreon vers l'équipement supervisé.

Installation​

  1. Installez le Plugin Centreon sur tous les collecteurs Centreon devant superviser des resources Hyper-V NSCP API :
yum install centreon-plugin-Applications-Protocol-Nrpe
  1. Sur l'interface Web de Centreon, installez le Pack Hyper-V NSCP API depuis la page Configuration > Packs de plugins.

Configuration​

Hôte​

  • Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  • Complétez les champs Nom, Alias et IP Address / DNS correspondant à votre serveur Hyper-V.
  • Appliquez un des modèles d'hôtes suivants :
MandatoryNameDescription
NSCPRESTAPIPORTPort used (Default: 8443)
NSCPRESTAPIPROTOProtocol used (Default: https)
NSCPRESTAPIUSERNAMENSClient API username
NSCPRESTAPIPASSWORDNSClient API password
NSCPRESTAPILEGACYPASSWORDNSClient API legacy authentication password
NSCPRESTAPIEXTRAOPTIONSAny extra option you may want to add to the command (eg. a --insecure)

Comment puis-je tester le Plugin et que signifient les options des commandes ?​

Une fois le Plugin installé, vous pouvez tester la bonne configuration NSClient directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine :

/usr/lib/centreon/plugins/centreon_protocol_nrpe.pl \
    --plugin=apps::protocols::nrpe::plugin \
    --mode=query \
    --custommode=nsclient \
    --hostname='10.0.0.1' \
    --username=centreon \
    --password=centreon \
    --insecure \
    --http-backend=curl \
    --command=check_version

La commande devrait retourner un message de sortie similaire à :

0.5.2.41 2018-04-26

Vous pouvez maintenant tester le Plugin Hyper-V :

/usr/lib/centreon/plugins/centreon_protocol_nrpe.pl \
    --plugin=apps::protocols::nrpe::plugin \
    --mode=query \
    --custommode=nsclient \
    --hostname='10.0.0.1' \
    --username=centreon \
    --password=centreon \
    --insecure \
    --http-backend=curl \
    --command=check_centreon_plugins \
    --arg='apps::microsoft::hyperv::2012::local::plugin' \
    --arg='node-vm-status' \
    --arg='--filter-vm="" --verbose' \
    --verbose

La commande devrait retourner un message de sortie similaire à :

OK: All virtual machines are ok 
VM 'vm1' status: Operating normally (state: Running, is clustered: 1)
VM 'vm2' status: Operating normally (state: Running, is clustered: 0)
VM 'vm3' status: Operating normally (state: Running, is clustered: 1)

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_protocol_nrpe.pl \
    --plugin=apps::protocols::nrpe::plugin \
    --mode=query \
    --custommode=nsclient \
    --hostname='10.0.0.1' \
    --username=centreon \
    --password=centreon \
    --insecure \
    --http-backend=curl \
    --command=check_centreon_plugins \
    --arg='apps::microsoft::hyperv::2012::local::plugin' \
    --arg='node-vm-status' \
    --arg='--help'

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

/usr/lib/centreon/plugins/centreon_protocol_nrpe.pl \
    --plugin=apps::protocols::nrpe::plugin \
    --mode=query \
    --custommode=nsclient \
    --hostname='10.0.0.1' \
    --username=centreon \
    --password=centreon \
    --insecure \
    --http-backend=curl \
    --command=check_centreon_plugins \
    --arg='apps::microsoft::hyperv::2012::local::plugin' \
    --arg='xxx' \
    --arg='--list-mode'

Diagnostic des erreurs communes​

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