Hyper-V NSCP Rest API
Pack Assetsβ
Templatesβ
The Centreon Pack Hyper-V brings 2 host templates:
- Virt-Hyperv-Node-Nscp-Restapi-custom
- Virt-Hyperv-Scvmm-Nscp-Restapi-custom
It brings the following service templates:
Service Alias | Service Template | Default | Discovery |
---|---|---|---|
Node-Integration-Service | Virt-Hyperv-Node-Integration-Service-Nscp-Restapi | X | |
Node-Replication | Virt-Hyperv-Node-Replication-Nscp-Restapi | X | |
Node-Snapshot | Virt-Hyperv-Node-Snapshot-Nscp-Restapi | X | |
Node-Vm-Status | Virt-Hyperv-Node-Vm-Status-Nscp-Restapi | X | |
Scvmm-Integration-Service | Virt-Hyperv-Scvmm-Integration-Service-Nscp-Restapi | X | |
Scvmm-Snapshot | Virt-Hyperv-Scvmm-Snapshot-Nscp-Restapi | X | |
Scvmm-Vm-Status | Virt-Hyperv-Scvmm-Vm-Status-Nscp-Restapi | X |
Discovery rulesβ
- Hosts
Rule name | Description |
---|---|
Virt-Hyperv-Nscp-Restapi-HostDiscovery-Scvmm-Vm | Discover the VMs bound to a SCVMM |
Collected metrics & statusβ
- Node-Integration-Service
- Node-Replication
- Node-Snapshot
- Node-Vm-Status
- Scvmm-Integration-Service
- Scvmm-Snapshot
- Scvmm-Vm-Status
Metric name | Description | Unit |
---|---|---|
global status | Global status of virtual machines integration services | |
service status | Primary and secondary status of each virtual machines services |
Metric name | Description | Unit |
---|---|---|
replication status | Health replication status of each virtual machines |
Metric name | Description | Unit |
---|---|---|
vm.snapshot.time.last.execution.seconds | Last snapshot execution time of each virtual machines | s |
Metric name | Description | Unit |
---|---|---|
vm status | Status of each virtual machines |
Metric name | Description | Unit |
---|---|---|
status | Addition status of each virtual machines | |
osshutdown status | Operating system shutdown status of each virtual machines | |
timesync status | Time synchronization status of each virtual machines | |
dataexchange status | Data exchange status of each virtual machines | |
heartbeat status | Heartbeat status of each virtual machines | |
backup status | Backup status of each virtual machines |
Metric name | Description | Unit |
---|---|---|
vm.snapshot.time.last.execution.seconds | Last snapshot execution time of each virtual machines | s |
Metric name | Description | Unit |
---|---|---|
vm status | Status of each virtual machines |
Prerequisitesβ
NSClient Configurationβ
To monitor Hyper-V through NRPE, install the Centreon packaged version of the NSClient++ agent. Please follow our official documentation.
Please download and install the last release of Centreon-NSClient-xxx.exe: https://github.com/centreon/centreon-nsclient-build/releases.
By default, the username/password is centreon/centreon.
Network flowβ
The target equipment must be reachable from the Centreon poller on the TCP/8443 port.
Setupβ
- Online License
- Offline License
- Install the Centreon package on every Centreon poller expected to monitor Hyper-V NSCP API resources:
yum install centreon-plugin-Applications-Protocol-Nrpe
- On the Centreon web interface, install the Hyper-V NSCP API Centreon Pack on the Configuration > Monitoring Connector Manager page.
- Install the Centreon package on every Centreon poller expected to monitor Hyper-V NSCP API resources:
yum install centreon-plugin-Applications-Protocol-Nrpe
- Install the Hyper-V NSCP API Centreon Pack RPM on the Centreon central server:
yum install centreon-pack-virtualization-hyperv-nscp-restapi
- On the Centreon web interface, install the Hyper-V NSCP API Centreon Pack on the Configuration > Monitoring Connector Manager page.
Configurationβ
Hostβ
- Add a new host and apply one of following host templates
Once the template is applied, some macros have to be configured.
- Virt-Hyperv-Node-Nscp-Restapi-custom
- Virt-Hyperv-Scvmm-Nscp-Restapi-custom
Mandatory | Name | Description |
---|---|---|
NSCPRESTAPIPORT | Port used (Default: 8443) | |
NSCPRESTAPIPROTO | Protocol used (Default: https) | |
NSCPRESTAPIUSERNAME | NSClient API username | |
NSCPRESTAPIPASSWORD | NSClient API password | |
NSCPRESTAPILEGACYPASSWORD | NSClient API legacy authentication password | |
NSCPRESTAPIEXTRAOPTIONS | Any extra option you may want to add to the command (eg. a --insecure) |
Mandatory | Name | Description |
---|---|---|
NSCPRESTAPIPORT | Port used (Default: 8443) | |
NSCPRESTAPIPROTO | Protocol used (Default: https) | |
NSCPRESTAPIUSERNAME | NSClient API username | |
NSCPRESTAPIPASSWORD | NSClient API password | |
NSCPRESTAPILEGACYPASSWORD | NSClient API legacy authentication password | |
NSCPRESTAPIEXTRAOPTIONS | Any extra option you may want to add to the command (eg. a --insecure) | |
X | SCVMMHOSTNAME | SCVMM address (Default: localhost) |
X | SCVMMUSERNAME | SCVMM username |
X | SCVMMPASSWORD | SCVMM password |
X | SCVMMPORT | SCVMM port used (Default: 8001) |
How to check in the CLI that the configuration is OK and what are the main options for?β
Once the plugin is installed, log into your Centreon Poller CLI using the centreon-engine user account and test the Plugin by running the following command to check NSClient configuration:
/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
The expected command output is shown below:
0.5.2.41 2018-04-26
Check the Hyper-V Plugin by running the following command:
/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
The expected command output is shown below:
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)
All available options for a given mode can be displayed by adding the
--help
parameter to the command:
/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'
All available modes can be displayed by adding the
--list-mode
parameter to the command:
/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'
Troubleshootingβ
Please find all the troubleshooting documentation for the Centreon Plugins on the dedicated page