WhatsUpGoldPS

0.1.20

helpers/f5/Get-F5Dashboard.ps1

                                # =============================================================================

# F5 BIG-IP Dashboard Report Generator

# Uses F5Helpers.ps1 to query one or more BIG-IP appliances and produces

# an interactive HTML dashboard showing virtual servers, pools, pool members,

# and their live status - similar to a SolarWinds F5 dashboard view.

#

# Prerequisites:

#   - PowerShell 5.1+ or PowerShell 7+

#   - Network access to the BIG-IP management interface (port 443 by default)

#   - A user account with at least Guest or Operator role on the BIG-IP

#

# Usage:

#   .\Get-F5Dashboard.ps1                                                   # Prompts for host(s), tries default ports

#   .\Get-F5Dashboard.ps1 -F5Hosts "bigip01.domain.com"                     # Single device, default ports (443, 8443)

#   .\Get-F5Dashboard.ps1 -F5Hosts "bigip01","bigip02" -TcpPorts 443,8443  # Multiple devices + ports

#   .\Get-F5Dashboard.ps1 -F5Hosts (Get-Content .\hosts.txt)                # Hosts from a file

#   # Then open the generated HTML file in a browser.

# =============================================================================

param (

    [Parameter(Mandatory = $false)]

    [string[]]$F5Hosts,

    [Parameter(Mandatory = $false)]

    [int[]]$TcpPorts = @(443, 8443),

    [Parameter(Mandatory = $false)]

    [pscredential]$F5Credential

)

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

# Dot-source the F5 helpers (adjust path if running from a different location)

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

if (Test-Path $helpersPath) {

    . $helpersPath

}

else {

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

}

# Import WhatsUpGoldPS module if available (for WUG integration)

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

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

        Import-Module -Name WhatsUpGoldPS

    }

}

# If no hosts were provided, prompt for one or more (comma-separated)

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

    $hostInput = Read-Host -Prompt "Enter F5 BIG-IP hostname(s) or IP(s) (comma-separated)"

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

}

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

    throw "At least one F5 BIG-IP host must be specified."

}

# Credential (reused across all devices)

if (-not $F5Credential) {

    $F5Credential = Get-Credential -Message "Enter F5 BIG-IP credentials"

}

# Output paths

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

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

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

# Ensure output directory exists

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

# --- Collect data from each F5 device + port combo ---------------------------

$allDashboardData = @()

foreach ($f5Host in $F5Hosts) {

    $connected = $false

    Write-Host "Processing $f5Host ..." -ForegroundColor Cyan

    foreach ($port in $TcpPorts) {

        if ($connected) { break }

        Write-Host "  Trying ${f5Host}:${port} ..." -ForegroundColor DarkCyan

        try {

            Connect-F5Server -F5Host $f5Host -Credential $F5Credential -Port $port -IgnoreSSLErrors

            # Grab system info for context

            $sysInfo = Get-F5SystemInfo

            Write-Host "  Connected on port ${port}: $($sysInfo.Hostname) running BIG-IP v$($sysInfo.Version)" -ForegroundColor Green

            # Build the combined dashboard data

            $dashData = Get-F5Dashboard -IncludeStats $true

            # Tag each row with the F5 device hostname and port for multi-device reports

            foreach ($row in $dashData) {

                $row | Add-Member -NotePropertyName "F5Device" -NotePropertyValue $sysInfo.Hostname -Force

                $row | Add-Member -NotePropertyName "F5Port"   -NotePropertyValue $port             -Force

            }

            $allDashboardData += $dashData

            Write-Host "  Retrieved $($dashData.Count) rows ($(@($dashData | Select-Object -Unique VSName).Count) unique VS)." -ForegroundColor Green

            $connected = $true

        }

        catch {

            Write-Warning "  Failed on ${f5Host}:${port} - $($_.Exception.Message)"

        }

    }

    if (-not $connected) {

        Write-Warning "Could not connect to $f5Host on any port ($($TcpPorts -join ', '))"

    }

}

if ($allDashboardData.Count -eq 0) {

    Write-Warning "No data collected from any F5 device. Exiting."

    return

}

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

# JSON export

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

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

# HTML dashboard

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

Export-F5DashboardHtml -DashboardData $allDashboardData -OutputPath $htmlPath -ReportTitle "F5 BIG-IP Dashboard" -TemplatePath $templatePath

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

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

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

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

    Start-Process $htmlPath

}

# --- Optional: WUG Integration Summary --------------------------------------

# If WhatsUpGoldPS is loaded, you could push F5 VS as device attributes.

# Example (uncomment to use):

#

# if ($global:WUGBearerHeaders) {

#     foreach ($row in $allDashboardData) {

#         # Find matching WUG device by IP

#         $wugDevice = Get-WUGDevice -Search $row.VSAddress | Select-Object -First 1

#         if ($wugDevice) {

#             Set-WUGDeviceAttribute -DeviceId $wugDevice.id -AttributeName "F5.VSName" -AttributeValue $row.VSName

#             Set-WUGDeviceAttribute -DeviceId $wugDevice.id -AttributeName "F5.VSStatus" -AttributeValue $row.VSStatus

#             Set-WUGDeviceAttribute -DeviceId $wugDevice.id -AttributeName "F5.Pool" -AttributeValue $row.PoolName

#             Set-WUGDeviceAttribute -DeviceId $wugDevice.id -AttributeName "F5.MemberCount" -AttributeValue (($allDashboardData | Where-Object { $_.VSName -eq $row.VSName }).Count)

#         }

#     }

#     Write-Host "F5 attributes synced to WhatsUp Gold devices." -ForegroundColor Green

# }

Write-Host "`nDone." -ForegroundColor Green

# SIG # Begin signature block

# MIIVlwYJKoZIhvcNAQcCoIIViDCCFYQCAQExDzANBglghkgBZQMEAgEFADB5Bgor

# BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG

# KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCD9I/FFh6U8ZiUc

# aL4juNuFUzsHRNz6LZM+igGJ4O/fg6CCEdMwggVvMIIEV6ADAgECAhBI/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

# BAGCNwIBFTAvBgkqhkiG9w0BCQQxIgQgrk5bh3RgQpDfwQUsSERhIUEqoV9CD9OI

# DLTYRurUrpcwDQYJKoZIhvcNAQEBBQAEggIAWsNELA+zEZMYOZAOJHI88nHd2UBd

# B1kInp0sJyX87mGknC2rPTVLBCzGGXRQJRWLIhnTpc8+3OkevpX5Du3JDnLLlKYK

# tCdvpPdmLtQoKbn7/07KuJYT4CIneAIClxbUTgqJcrECHfXAbfoMenAyjkNZNqSl

# bzhI6mNPpz57F1ebTToVLryHLXS3Cnd/1Gs+W8AHe2fno3wduPR+9PAvO+Nda1/H

# 4ENZvzO6gPo+mhP/d4ML2R/M3Z5VwA2VfRQ1/aaWEhajNckWaBNkgSaoYnFMN3sC

# cW2MvhGpP3pUTq/ZwuJ0bqd0lG4ckUxktATyMMFB7n9IBArKxn0TykxZ/R3BckJa

# Y/p4h0SLS0OS7XIiVIfNUXnHD0Fks+khPpZ5rNMUExkYxFqN/O+F+kDjbd/n0xc3

# APMHzH6g3QbF/XpjXHTc0XzomtHD05ycj3j16Sh6yMBAFTpardX+DL4jhD0Csg/e

# +VVuj+7cCRWBfmTTUcrZkCr3MwBh05ZmLdIvzqRI3N3jko4gviOep5Z5chT31EnT

# DBB6YDBLAoMkqqMA3WGRfIfwOSEzjo3m8/VSGFnM6JXib4rfsIOBCF2qn42iCjFn

# mpMmDfgus1Uzcxm1sLd+gQxTzSoQrjLloHvguNU1cV+kqyTL7iNTAv1mfrOeIB/C

# i/0rQ6gtX/wCP4Y=

# SIG # End signature block