WhatsUpGoldPS

0.1.20

helpers/hyperv/Get-HypervDashboard.ps1

                                <#

.SYNOPSIS

    Generates an interactive HTML dashboard report for Hyper-V environments.

.DESCRIPTION

    Orchestration script that connects to one or more Hyper-V hosts via CIM sessions,

    collects VM details (CPU, memory, disk, network, snapshots, replication), and

    produces a searchable, sortable Bootstrap Table HTML dashboard. Supports

    WinRM and DCOM transport protocols. Output includes both a JSON data file

    and a self-contained HTML report.

.PARAMETER HypervHosts

    One or more Hyper-V host names or IP addresses. If omitted, prompts interactively.

    Accepts an array of strings (e.g. from Get-Content).

.PARAMETER HypervCredential

    A PSCredential object for authenticating to the Hyper-V hosts. If omitted,

    prompts interactively via Get-Credential.

.PARAMETER UseDCOM

    Use DCOM transport instead of the default WinRM (WSMan) for CIM sessions.

    Useful for hosts that do not have WinRM enabled.

.EXAMPLE

    .\Get-HypervDashboard.ps1

    Prompts for Hyper-V host(s) and credentials, then generates the dashboard.

.EXAMPLE

    .\Get-HypervDashboard.ps1 -HypervHosts "hyperv01.lab.local" -HypervCredential (Get-Credential)

    Generates a dashboard for a single Hyper-V host.

.EXAMPLE

    .\Get-HypervDashboard.ps1 -HypervHosts "hv01","hv02" -UseDCOM

    Connects to multiple hosts via DCOM and generates a combined dashboard.

.EXAMPLE

    $hosts = Get-Content .\hosts.txt

    .\Get-HypervDashboard.ps1 -HypervHosts $hosts -HypervCredential $cred

    Reads host names from a file and generates the dashboard for all hosts.

.OUTPUTS

    System.Void

    Produces a JSON file (hyperv_dashboard.json) and an HTML dashboard

    (Hyperv-Dashboard.html) in the system temp directory, then opens the HTML in the default browser.

.NOTES

    Author  : jason@wug.ninja

    Version : 1.0.0

    Date    : 2025-07-15

    Requires: PowerShell 5.1+, Hyper-V PowerShell module, HypervHelpers.ps1 in the same directory.

.LINK

    https://github.com/jayyx2/WhatsUpGoldPS

#>

param (

    [Parameter(Mandatory = $false)]

    [string[]]$HypervHosts,

    [Parameter(Mandatory = $false)]

    [pscredential]$HypervCredential,

    [Parameter(Mandatory = $false)]

    [switch]$UseDCOM

)

# --- Configuration -----------------------------------------------------------

$helpersPath = Join-Path $PSScriptRoot "HypervHelpers.ps1"

if (Test-Path $helpersPath) {

    . $helpersPath

}

else {

    throw "HypervHelpers.ps1 not found at $helpersPath. Ensure it is in the same directory."

}

if (Get-Module -ListAvailable -Name WhatsUpGoldPS) {

    if (-not (Get-Module -Name WhatsUpGoldPS)) {

        Import-Module -Name WhatsUpGoldPS

    }

}

# --- Input prompts -----------------------------------------------------------

if (-not $HypervHosts -or $HypervHosts.Count -eq 0) {

    $hostInput = Read-Host -Prompt "Enter Hyper-V host(s) (comma-separated)"

    $HypervHosts = $hostInput -split ',' | ForEach-Object { $_.Trim() } | Where-Object { $_ -ne '' }

}

if (-not $HypervHosts -or $HypervHosts.Count -eq 0) {

    throw "At least one Hyper-V host must be specified."

}

if (-not $HypervCredential) {

    $HypervCredential = Get-Credential -Message "Enter Hyper-V host credentials"

}

# Output paths

$outputDir = if ($env:TEMP) { $env:TEMP } else { "C:\temp" }

$jsonPath  = Join-Path $outputDir "hyperv_dashboard.json"

$htmlPath  = Join-Path $outputDir "Hyperv-Dashboard.html"

if (-not (Test-Path $outputDir)) { New-Item -ItemType Directory -Path $outputDir -Force | Out-Null }

# --- Connect and collect data ------------------------------------------------

$sessions = @()

foreach ($hvHost in $HypervHosts) {

    Write-Host "Connecting to $hvHost ..." -ForegroundColor Cyan

    try {

        $splat = @{ ComputerName = $hvHost; Credential = $HypervCredential }

        if ($UseDCOM) { $splat["UseDCOM"] = $true }

        $session = Connect-HypervHost @splat

        $sessions += $session

        Write-Host "  Connected to $hvHost" -ForegroundColor Green

    }

    catch {

        Write-Warning "Failed to connect to ${hvHost}: $($_.Exception.Message)"

    }

}

if ($sessions.Count -eq 0) {

    Write-Warning "No Hyper-V hosts connected. Exiting."

    return

}

Write-Host "`nCollecting VM data from $($sessions.Count) host(s)..." -ForegroundColor Cyan

$dashboardData = Get-HypervDashboard -CimSessions $sessions

if (-not $dashboardData -or $dashboardData.Count -eq 0) {

    Write-Warning "No VM data collected. Exiting."

    return

}

# --- Summary -----------------------------------------------------------------

$running = @($dashboardData | Where-Object { $_.State -eq 'Running' }).Count

$off     = @($dashboardData | Where-Object { $_.State -eq 'Off' }).Count

$other   = $dashboardData.Count - $running - $off

$hosts   = @($dashboardData | Select-Object -ExpandProperty Host -Unique).Count

Write-Host "`n--- Hyper-V Summary ---" -ForegroundColor Yellow

Write-Host "  Hosts:   $hosts"

Write-Host "  Running: $running" -ForegroundColor Green

Write-Host "  Off:     $off" -ForegroundColor Red

if ($other -gt 0) { Write-Host "  Other:   $other" -ForegroundColor DarkYellow }

# --- Generate outputs --------------------------------------------------------

$dashboardData | ConvertTo-Json -Depth 5 | Out-File $jsonPath -Force -Encoding UTF8

Write-Host "`nJSON data written to $jsonPath" -ForegroundColor Yellow

$templatePath = Join-Path $PSScriptRoot "Hyperv-Dashboard-Template.html"

Export-HypervDashboardHtml -DashboardData $dashboardData -OutputPath $htmlPath -ReportTitle "Hyper-V Dashboard" -TemplatePath $templatePath

Write-Host "HTML dashboard written to $htmlPath" -ForegroundColor Yellow

# --- Cleanup CIM sessions ----------------------------------------------------

foreach ($s in $sessions) {

    Remove-CimSession -CimSession $s -ErrorAction SilentlyContinue

}

# --- Optional: Open in browser -----------------------------------------------

$openBrowser = Read-Host -Prompt "Open dashboard in browser? (Y/N)"

if ($openBrowser -match '^[Yy]') {

    Start-Process $htmlPath

}

Write-Host "`nDone." -ForegroundColor Green

# SIG # Begin signature block

# MIIVlwYJKoZIhvcNAQcCoIIViDCCFYQCAQExDzANBglghkgBZQMEAgEFADB5Bgor

# BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG

# KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCABx095IgOMmUOs

# tu85WUSEVUZuxZ3ZB72WnMUwd+tBzKCCEdMwggVvMIIEV6ADAgECAhBI/JO0YFWU

# jTanyYqJ1pQWMA0GCSqGSIb3DQEBDAUAMHsxCzAJBgNVBAYTAkdCMRswGQYDVQQI

# DBJHcmVhdGVyIE1hbmNoZXN0ZXIxEDAOBgNVBAcMB1NhbGZvcmQxGjAYBgNVBAoM

# EUNvbW9kbyBDQSBMaW1pdGVkMSEwHwYDVQQDDBhBQUEgQ2VydGlmaWNhdGUgU2Vy

# dmljZXMwHhcNMjEwNTI1MDAwMDAwWhcNMjgxMjMxMjM1OTU5WjBWMQswCQYDVQQG

# EwJHQjEYMBYGA1UEChMPU2VjdGlnbyBMaW1pdGVkMS0wKwYDVQQDEyRTZWN0aWdv

# IFB1YmxpYyBDb2RlIFNpZ25pbmcgUm9vdCBSNDYwggIiMA0GCSqGSIb3DQEBAQUA

# A4ICDwAwggIKAoICAQCN55QSIgQkdC7/FiMCkoq2rjaFrEfUI5ErPtx94jGgUW+s

# hJHjUoq14pbe0IdjJImK/+8Skzt9u7aKvb0Ffyeba2XTpQxpsbxJOZrxbW6q5KCD

# J9qaDStQ6Utbs7hkNqR+Sj2pcaths3OzPAsM79szV+W+NDfjlxtd/R8SPYIDdub7

# P2bSlDFp+m2zNKzBenjcklDyZMeqLQSrw2rq4C+np9xu1+j/2iGrQL+57g2extme

# me/G3h+pDHazJyCh1rr9gOcB0u/rgimVcI3/uxXP/tEPNqIuTzKQdEZrRzUTdwUz

# T2MuuC3hv2WnBGsY2HH6zAjybYmZELGt2z4s5KoYsMYHAXVn3m3pY2MeNn9pib6q

# RT5uWl+PoVvLnTCGMOgDs0DGDQ84zWeoU4j6uDBl+m/H5x2xg3RpPqzEaDux5mcz

# mrYI4IAFSEDu9oJkRqj1c7AGlfJsZZ+/VVscnFcax3hGfHCqlBuCF6yH6bbJDoEc

# QNYWFyn8XJwYK+pF9e+91WdPKF4F7pBMeufG9ND8+s0+MkYTIDaKBOq3qgdGnA2T

# OglmmVhcKaO5DKYwODzQRjY1fJy67sPV+Qp2+n4FG0DKkjXp1XrRtX8ArqmQqsV/

# AZwQsRb8zG4Y3G9i/qZQp7h7uJ0VP/4gDHXIIloTlRmQAOka1cKG8eOO7F/05QID

# AQABo4IBEjCCAQ4wHwYDVR0jBBgwFoAUoBEKIz6W8Qfs4q8p74Klf9AwpLQwHQYD

# VR0OBBYEFDLrkpr/NZZILyhAQnAgNpFcF4XmMA4GA1UdDwEB/wQEAwIBhjAPBgNV

# HRMBAf8EBTADAQH/MBMGA1UdJQQMMAoGCCsGAQUFBwMDMBsGA1UdIAQUMBIwBgYE

# VR0gADAIBgZngQwBBAEwQwYDVR0fBDwwOjA4oDagNIYyaHR0cDovL2NybC5jb21v

# ZG9jYS5jb20vQUFBQ2VydGlmaWNhdGVTZXJ2aWNlcy5jcmwwNAYIKwYBBQUHAQEE

# KDAmMCQGCCsGAQUFBzABhhhodHRwOi8vb2NzcC5jb21vZG9jYS5jb20wDQYJKoZI

# hvcNAQEMBQADggEBABK/oe+LdJqYRLhpRrWrJAoMpIpnuDqBv0WKfVIHqI0fTiGF

# OaNrXi0ghr8QuK55O1PNtPvYRL4G2VxjZ9RAFodEhnIq1jIV9RKDwvnhXRFAZ/ZC

# J3LFI+ICOBpMIOLbAffNRk8monxmwFE2tokCVMf8WPtsAO7+mKYulaEMUykfb9gZ

# pk+e96wJ6l2CxouvgKe9gUhShDHaMuwV5KZMPWw5c9QLhTkg4IUaaOGnSDip0TYl

# d8GNGRbFiExmfS9jzpjoad+sPKhdnckcW67Y8y90z7h+9teDnRGWYpquRRPaf9xH

# +9/DUp/mBlXpnYzyOmJRvOwkDynUWICE5EV7WtgwggYaMIIEAqADAgECAhBiHW0M

# UgGeO5B5FSCJIRwKMA0GCSqGSIb3DQEBDAUAMFYxCzAJBgNVBAYTAkdCMRgwFgYD

# VQQKEw9TZWN0aWdvIExpbWl0ZWQxLTArBgNVBAMTJFNlY3RpZ28gUHVibGljIENv

# ZGUgU2lnbmluZyBSb290IFI0NjAeFw0yMTAzMjIwMDAwMDBaFw0zNjAzMjEyMzU5

# NTlaMFQxCzAJBgNVBAYTAkdCMRgwFgYDVQQKEw9TZWN0aWdvIExpbWl0ZWQxKzAp

# BgNVBAMTIlNlY3RpZ28gUHVibGljIENvZGUgU2lnbmluZyBDQSBSMzYwggGiMA0G

# CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCbK51T+jU/jmAGQ2rAz/V/9shTUxjI

# ztNsfvxYB5UXeWUzCxEeAEZGbEN4QMgCsJLZUKhWThj/yPqy0iSZhXkZ6Pg2A2NV

# DgFigOMYzB2OKhdqfWGVoYW3haT29PSTahYkwmMv0b/83nbeECbiMXhSOtbam+/3

# 6F09fy1tsB8je/RV0mIk8XL/tfCK6cPuYHE215wzrK0h1SWHTxPbPuYkRdkP05Zw

# mRmTnAO5/arnY83jeNzhP06ShdnRqtZlV59+8yv+KIhE5ILMqgOZYAENHNX9SJDm

# +qxp4VqpB3MV/h53yl41aHU5pledi9lCBbH9JeIkNFICiVHNkRmq4TpxtwfvjsUe

# dyz8rNyfQJy/aOs5b4s+ac7IH60B+Ja7TVM+EKv1WuTGwcLmoU3FpOFMbmPj8pz4

# 4MPZ1f9+YEQIQty/NQd/2yGgW+ufflcZ/ZE9o1M7a5Jnqf2i2/uMSWymR8r2oQBM

# dlyh2n5HirY4jKnFH/9gRvd+QOfdRrJZb1sCAwEAAaOCAWQwggFgMB8GA1UdIwQY

# MBaAFDLrkpr/NZZILyhAQnAgNpFcF4XmMB0GA1UdDgQWBBQPKssghyi47G9IritU

# pimqF6TNDDAOBgNVHQ8BAf8EBAMCAYYwEgYDVR0TAQH/BAgwBgEB/wIBADATBgNV

# HSUEDDAKBggrBgEFBQcDAzAbBgNVHSAEFDASMAYGBFUdIAAwCAYGZ4EMAQQBMEsG

# A1UdHwREMEIwQKA+oDyGOmh0dHA6Ly9jcmwuc2VjdGlnby5jb20vU2VjdGlnb1B1

# YmxpY0NvZGVTaWduaW5nUm9vdFI0Ni5jcmwwewYIKwYBBQUHAQEEbzBtMEYGCCsG

# AQUFBzAChjpodHRwOi8vY3J0LnNlY3RpZ28uY29tL1NlY3RpZ29QdWJsaWNDb2Rl

# U2lnbmluZ1Jvb3RSNDYucDdjMCMGCCsGAQUFBzABhhdodHRwOi8vb2NzcC5zZWN0

# aWdvLmNvbTANBgkqhkiG9w0BAQwFAAOCAgEABv+C4XdjNm57oRUgmxP/BP6YdURh

# w1aVcdGRP4Wh60BAscjW4HL9hcpkOTz5jUug2oeunbYAowbFC2AKK+cMcXIBD0Zd

# OaWTsyNyBBsMLHqafvIhrCymlaS98+QpoBCyKppP0OcxYEdU0hpsaqBBIZOtBajj

# cw5+w/KeFvPYfLF/ldYpmlG+vd0xqlqd099iChnyIMvY5HexjO2AmtsbpVn0OhNc

# WbWDRF/3sBp6fWXhz7DcML4iTAWS+MVXeNLj1lJziVKEoroGs9Mlizg0bUMbOalO

# hOfCipnx8CaLZeVme5yELg09Jlo8BMe80jO37PU8ejfkP9/uPak7VLwELKxAMcJs

# zkyeiaerlphwoKx1uHRzNyE6bxuSKcutisqmKL5OTunAvtONEoteSiabkPVSZ2z7

# 6mKnzAfZxCl/3dq3dUNw4rg3sTCggkHSRqTqlLMS7gjrhTqBmzu1L90Y1KWN/Y5J

# KdGvspbOrTfOXyXvmPL6E52z1NZJ6ctuMFBQZH3pwWvqURR8AgQdULUvrxjUYbHH

# j95Ejza63zdrEcxWLDX6xWls/GDnVNueKjWUH3fTv1Y8Wdho698YADR7TNx8X8z2

# Bev6SivBBOHY+uqiirZtg0y9ShQoPzmCcn63Syatatvx157YK9hlcPmVoa1oDE5/

# L9Uo2bC5a4CH2RwwggY+MIIEpqADAgECAhAHnODk0RR/hc05c892LTfrMA0GCSqG

# SIb3DQEBDAUAMFQxCzAJBgNVBAYTAkdCMRgwFgYDVQQKEw9TZWN0aWdvIExpbWl0

# ZWQxKzApBgNVBAMTIlNlY3RpZ28gUHVibGljIENvZGUgU2lnbmluZyBDQSBSMzYw

# HhcNMjYwMjA5MDAwMDAwWhcNMjkwNDIxMjM1OTU5WjBVMQswCQYDVQQGEwJVUzEU

# MBIGA1UECAwLQ29ubmVjdGljdXQxFzAVBgNVBAoMDkphc29uIEFsYmVyaW5vMRcw

# FQYDVQQDDA5KYXNvbiBBbGJlcmlubzCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCC

# AgoCggIBAPN6aN4B1yYWkI5b5TBj3I0VV/peETrHb6EY4BHGxt8Ap+eT+WpEpJyE

# tRYPxEmNJL3A38Bkg7mwzPE3/1NK570ZBCuBjSAn4mSDIgIuXZnvyBO9W1OQs5d6

# 7MlJLUAEufl18tOr3ST1DeO9gSjQSAE5Nql0QDxPnm93OZBon+Fz3CmE+z3MwAe2

# h4KdtRAnCqwM+/V7iBdbw+JOxolpx+7RVjGyProTENIG3pe/hKvPb501lf8uBAAD

# LdjZr5ip8vIWbf857Yw1Bu10nVI7HW3eE8Cl5//d1ribHlzTzQLfttW+k+DaFsKZ

# BBL56l4YAlIVRsrOiE1kdHYYx6IGrEA809R7+TZA9DzGqyFiv9qmJAbL4fDwetDe

# yIq+Oztz1LvEdy8Rcd0JBY+J4S0eDEFIA3X0N8VcLeAwabKb9AjulKXwUeqCJLvN

# 79CJ90UTZb2+I+tamj0dn+IKMEsJ4v4Ggx72sxFr9+6XziodtTg5Luf2xd6+Phha

# mOxF2px9LObhBLLEMyRsCHZIzVZOFKu9BpHQH7ufGB+Sa80Tli0/6LEyn9+bMYWi

# 2ttn6lLOPThXMiQaooRUq6q2u3+F4SaPlxVFLI7OJVMhar6nW6joBvELTJPmANSM

# jDSRFDfHRCdGbZsL/keELJNy+jZctF6VvxQEjFM8/bazu6qYhrA7AgMBAAGjggGJ

# MIIBhTAfBgNVHSMEGDAWgBQPKssghyi47G9IritUpimqF6TNDDAdBgNVHQ4EFgQU

# 6YF0o0D5AVhKHbVocr8GaSIBibAwDgYDVR0PAQH/BAQDAgeAMAwGA1UdEwEB/wQC

# MAAwEwYDVR0lBAwwCgYIKwYBBQUHAwMwSgYDVR0gBEMwQTA1BgwrBgEEAbIxAQIB

# AwIwJTAjBggrBgEFBQcCARYXaHR0cHM6Ly9zZWN0aWdvLmNvbS9DUFMwCAYGZ4EM

# AQQBMEkGA1UdHwRCMEAwPqA8oDqGOGh0dHA6Ly9jcmwuc2VjdGlnby5jb20vU2Vj

# dGlnb1B1YmxpY0NvZGVTaWduaW5nQ0FSMzYuY3JsMHkGCCsGAQUFBwEBBG0wazBE

# BggrBgEFBQcwAoY4aHR0cDovL2NydC5zZWN0aWdvLmNvbS9TZWN0aWdvUHVibGlj

# Q29kZVNpZ25pbmdDQVIzNi5jcnQwIwYIKwYBBQUHMAGGF2h0dHA6Ly9vY3NwLnNl

# Y3RpZ28uY29tMA0GCSqGSIb3DQEBDAUAA4IBgQAEIsm4xnOd/tZMVrKwi3doAXvC

# wOA/RYQnFJD7R/bSQRu3wXEK4o9SIefye18B/q4fhBkhNAJuEvTQAGfqbbpxow03

# J5PrDTp1WPCWbXKX8Oz9vGWJFyJxRGftkdzZ57JE00synEMS8XCwLO9P32MyR9Z9

# URrpiLPJ9rQjfHMb1BUdvaNayomm7aWLAnD+X7jm6o8sNT5An1cwEAob7obWDM6s

# X93wphwJNBJAstH9Ozs6LwISOX6sKS7CKm9N3Kp8hOUue0ZHAtZdFl6o5u12wy+z

# zieGEI50fKnN77FfNKFOWKlS6OJwlArcbFegB5K89LcE5iNSmaM3VMB2ADV1FEcj

# GSHw4lTg1Wx+WMAMdl/7nbvfFxJ9uu5tNiT54B0s+lZO/HztwXYQUczdsFon3pjs

# Nrsk9ZlalBi5SHkIu+F6g7tWiEv3rtVApmJRnLkUr2Xq2a4nbslUCt4jKs5UX4V1

# nSX8OM++AXoyVGO+iTj7z+pl6XE9Gw/Td6WKKKsxggMaMIIDFgIBATBoMFQxCzAJ

# BgNVBAYTAkdCMRgwFgYDVQQKEw9TZWN0aWdvIExpbWl0ZWQxKzApBgNVBAMTIlNl

# Y3RpZ28gUHVibGljIENvZGUgU2lnbmluZyBDQSBSMzYCEAec4OTRFH+FzTlzz3Yt

# N+swDQYJYIZIAWUDBAIBBQCggYQwGAYKKwYBBAGCNwIBDDEKMAigAoAAoQKAADAZ

# BgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgELMQ4wDAYKKwYB

# BAGCNwIBFTAvBgkqhkiG9w0BCQQxIgQgSXGdUnk3IEteKlnwgc93e/AOFtcud+pf

# +pjty7iBVYIwDQYJKoZIhvcNAQEBBQAEggIAET6oGuEJCGYNzwfQTeR3lKT9QSmL

# Q8RhdKY8GV3xoOa2OdoDdt6wxyNGDfT4zfyUNMaG7QvWy/6VFHVbLOr7veoj6ZpA

# V0LAT0shlknBI3viQ9p8eQWl4seOdu/9bhIyOyBKa+nR43qeZUvtkH5x4WMgQDcv

# JpJGXNMkQyXBYNce5oK+TYeyU4aGe6W7r5CATCZpzwQGufV7RnsJLcYDADf3tq5c

# QZe1NN/i6mlMhCCoNqXWG+S0CsYndSdQZycpyirDH+yL1FfcJXiIy9Tf4gIzvnzy

# H6bQ8745S8Y8IJ+AOrOr7zv5+6iWLn2+IENWUezZNrQFI5PB5rPVA33yDDONw4Tp

# Np0tXisGmDmqxqxcpLTVxwiqnyL/y6XX060gOem1yzHNJhJ1hHZQXlTqLeXMhc4p

# ZUih6QNKPQcLWBYOKbWPxraTk1YKdPSU877WhVDJoEIAoiiVnDTRHs6rjc8bqUnw

# mzWEL9sfolLtf9wV3ISES02GRa9QQNg9iGL4fxsTEGLeyaodClw9qRUaYVy905O9

# zAukGq289CPNdCLGwzoOhUFENTP0HxLOUzCz+7ITA5muPnxkTRWSTafI2gGFywgk

# G40recwPvjy/qPqDkHOjqK4P+R2hwOfgkXM+URfpBJtg4jqGPymaw+rbuxL7AjCM

# 7y9T/sdnTDolMv8=

# SIG # End signature block