Back to the list of connectors

Hyper-V

Description

This connector provides hardware monitoring through Hyper-V PowerShell cmdlets. The user requires Hyper-V Administrators membership.

Connector ID: HyperV

Target

Typical platform: Hyper-V Servers

Operating system: Microsoft Windows

Prerequisites

Leverages: PowerShell

Technology and protocols: System Commands

Examples

CLI

hws HOSTNAME -t win -f HyperV --wmi -u USER

hws-config.yaml

hosts:
- host:
    hostname: <HOSTNAME> # Change with actual host name
    type: win
  selectedConnectors: [ HyperV ] # Optional, to load only this connector
  wmi:
    username: <USERNAME> # Change with actual credentials
    password: <PASSWORD> # Encrypted using hws-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: Name (regex)

Metrics

Type Collected Metrics Specific Attributes (Labels)
Virtual Machine
  • hw.energy{hw.type="vm"}
  • hw.status{hw.type="vm",state="present"}
  • hw.vm.power_state{state="on|off|suspended"}
  • info
  • vm.host.name
No results.