Get-HyperVVMPerformance

Hyper-V: Retrieves resource metering data for a virtual machine

Script

#Requires -Version 5.1
#Requires -Modules Hyper-V

[CmdletBinding()]
Param (
    [string]$ComputerName = "localhost",

    [PSCredential]$Credential,

    [Parameter(Mandatory = $true)]
    [string]$Name,

    [switch]$EnableMetering
)

Process {
    try {
        $params = @{
            'ComputerName' = $ComputerName
            'ErrorAction'  = 'Stop'
        }
        if ($Credential) { $params.Add('Credential', $Credential) }

        $vm = Get-VM @params | Where-Object { $_.Name -eq $Name -or $_.Id -eq $Name }

        if (-not $vm) {
            throw "Virtual machine '$Name' not found on '$ComputerName'."
        }

        if ($EnableMetering -and -not $vm.ResourceMeteringEnabled) {
            Enable-VMResourceMetering -VM $vm -ErrorAction Stop
            $vm = Get-VM -VM $vm # Refresh object
        }

        if (-not $vm.ResourceMeteringEnabled) {
            throw "Resource metering is not enabled for VM '$Name'. Use -EnableMetering to enable it."
        }

        $metrics = Measure-VM -VM $vm -ErrorAction Stop

        $result = [PSCustomObject]@{
            VMName                = $vm.Name
            AverageProcessorUsage = $metrics.AverageProcessorUsage
            AverageMemoryUsage    = $metrics.AverageMemoryUsage
            MaximumMemoryUsage    = $metrics.MaximumMemoryUsage
            MinimumMemoryUsage    = $metrics.MinimumMemoryUsage
            TotalDiskAllocation   = $metrics.TotalDiskAllocation
            NetworkInbound        = $metrics.NetworkInbound
            NetworkOutbound       = $metrics.NetworkOutbound
            MeteringDuration      = $metrics.MeteringDuration
            Status                = "Success"
            Timestamp             = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
        }

        Write-Output $result
    }
    catch {
        throw
    }
}

Customize

ComputerName string

Specifies the name of the Hyper-V host. Defaults to the local machine.

Credential PSCredential

Specifies the credentials to use for the remote connection.

Name string

Specifies the name or ID of the virtual machine.

EnableMetering switch

Off

Optional. If set, enables resource metering on the virtual machine if it is currently disabled.