Back to the list of connectors[1]

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[2] windows[3]

Source[4]

Target

Typical platform: Hyper-V Servers

Operating system: Microsoft Windows

Prerequisites

Leverages: PowerShell

Technology and protocols: Command Lines

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

Type Collected Metrics Specific Attributes
vm
  • hw.power_state{hw.type="vm", state="off|on|suspended"}
  • hw.vm.power_ratio
  • hw.parent.type
  • id
  • info
  • name
  • vm.host.name
No results.