Skip to main content

Hyper-V

Description

This connector enables hardware monitoring for Hyper-V through Hyper-V PowerShell cmdlets. The user needs a Hyper-V Administrators membership.

hardware windows

Target

Typical platform: Microsoft Windows

Operating system: Microsoft Windows

Prerequisites

Leverages: PowerShell

Technology and protocols: Commands

Examples

CLI

metricshub HOSTNAME -t win -c +HyperV --wmi -u USER

metricshub.yaml

resourceGroups:
<RESOURCE_GROUP>:
resources:
<HOSTNAME-ID>:
attributes:
host.name: <HOSTNAME> # Change with actual host name
host.type: win
connectors: [ +HyperV ] # Optional, to load only this connector
protocols:
wmi:
username: <USERNAME> # Change with actual credentials
password: <PASSWORD> # Encrypted using metricshub-encrypt

Connector Activation Criteria

The Hyper-V connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

  • The command below succeeds on the monitored host:
    • Command: Powershell.exe Get-VM
    • Output contains: State (regex)

Metrics

TypeCollected MetricsSpecific Attributes
vmhw.power_state{hw.type="vm", state="off|on|suspended"}
hw.status{hw.type="vm", state="present"}
hw.vm.power_ratio
hw.parent.type
id
info
name
vm.host.name