helpers/oci/Get-OCIDashboard.ps1
|
<#
.SYNOPSIS Generates an interactive HTML dashboard report for OCI environments. .DESCRIPTION Orchestration script that authenticates to Oracle Cloud Infrastructure, scans compartments for Compute instances, DB Systems, Autonomous Databases, and Load Balancers, and produces a searchable, sortable Bootstrap Table HTML dashboard. Output includes both a JSON data file and a self-contained HTML report. .PARAMETER TenancyId The OCID of the OCI tenancy (root compartment). If omitted, prompts interactively. .PARAMETER CompartmentIds Optional array of compartment OCIDs to limit scope. If omitted, discovers and scans all active compartments under the tenancy. .PARAMETER Region OCI region override (e.g. us-ashburn-1). Uses the configured default if omitted. .PARAMETER ConfigFile Path to the OCI config file. Defaults to ~/.oci/config. .PARAMETER ProfileName The OCI config profile name to use. Defaults to DEFAULT. .PARAMETER SkipDBSystems Exclude Oracle DB Systems from the dashboard results. .PARAMETER SkipAutonomousDBs Exclude Autonomous Databases from the dashboard results. .PARAMETER SkipLoadBalancers Exclude Load Balancers from the dashboard results. .EXAMPLE .\Get-OCIDashboard.ps1 -TenancyId "ocid1.tenancy.oc1..aaaa" Scans all active compartments and generates the dashboard. .EXAMPLE .\Get-OCIDashboard.ps1 -TenancyId $tid -Region "us-ashburn-1" Generates a dashboard for a specific OCI region. .EXAMPLE .\Get-OCIDashboard.ps1 -TenancyId $tid -CompartmentIds $compId Generates a dashboard for a specific compartment only. .EXAMPLE .\Get-OCIDashboard.ps1 -TenancyId $tid -SkipDBSystems -SkipLoadBalancers Generates a dashboard with only Compute and Autonomous DB resources. .OUTPUTS System.Void Produces a JSON file (oci_dashboard.json) and an HTML dashboard (OCI-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+, OCI.PSModules, OCI config file, OCIHelpers.ps1 in the same directory. .LINK https://github.com/jayyx2/WhatsUpGoldPS #> param ( [Parameter(Mandatory = $false)] [string]$TenancyId, [Parameter(Mandatory = $false)] [string[]]$CompartmentIds, [Parameter(Mandatory = $false)] [string]$Region, [Parameter(Mandatory = $false)] [string]$ConfigFile, [Parameter(Mandatory = $false)] [string]$ProfileName, [Parameter(Mandatory = $false)] [switch]$SkipDBSystems, [Parameter(Mandatory = $false)] [switch]$SkipAutonomousDBs, [Parameter(Mandatory = $false)] [switch]$SkipLoadBalancers ) # --- Configuration ----------------------------------------------------------- $helpersPath = Join-Path $PSScriptRoot "OCIHelpers.ps1" if (Test-Path $helpersPath) { . $helpersPath } else { throw "OCIHelpers.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 } } # --- Validate config --------------------------------------------------------- $connectSplat = @{} if ($ConfigFile) { $connectSplat["ConfigFile"] = $ConfigFile } if ($ProfileName) { $connectSplat["Profile"] = $ProfileName } Connect-OCIProfile @connectSplat # --- Input prompts ----------------------------------------------------------- if (-not $TenancyId) { $TenancyId = Read-Host -Prompt "Enter OCI Tenancy OCID" if (-not $TenancyId) { throw "Tenancy OCID is required." } } # Output paths $outputDir = if ($env:TEMP) { $env:TEMP } else { "C:\temp" } $jsonPath = Join-Path $outputDir "oci_dashboard.json" $htmlPath = Join-Path $outputDir "OCI-Dashboard.html" if (-not (Test-Path $outputDir)) { New-Item -ItemType Directory -Path $outputDir -Force | Out-Null } # --- Collect data ------------------------------------------------------------ Write-Host "`nScanning OCI resources..." -ForegroundColor Cyan $dashSplat = @{ TenancyId = $TenancyId IncludeDBSystems = (-not $SkipDBSystems) IncludeAutonomousDBs = (-not $SkipAutonomousDBs) IncludeLoadBalancers = (-not $SkipLoadBalancers) } if ($CompartmentIds) { $dashSplat["CompartmentIds"] = $CompartmentIds } if ($Region) { $dashSplat["Region"] = $Region } if ($ConfigFile) { $dashSplat["ConfigFile"] = $ConfigFile } if ($ProfileName) { $dashSplat["Profile"] = $ProfileName } $dashboardData = Get-OCIDashboard @dashSplat if (-not $dashboardData -or $dashboardData.Count -eq 0) { Write-Warning "No resources collected. Exiting." return } # --- Summary ----------------------------------------------------------------- $running = @($dashboardData | Where-Object { $_.LifecycleState -in 'RUNNING','ACTIVE','AVAILABLE' }).Count $stopped = $dashboardData.Count - $running $compute = @($dashboardData | Where-Object { $_.ResourceType -eq 'Compute' }).Count $dbs = @($dashboardData | Where-Object { $_.ResourceType -in 'DBSystem','AutonomousDB' }).Count $lbs = @($dashboardData | Where-Object { $_.ResourceType -eq 'LoadBalancer' }).Count Write-Host "`n--- OCI Summary ---" -ForegroundColor Yellow Write-Host " Total: $($dashboardData.Count)" Write-Host " Running/Active: $running" -ForegroundColor Green Write-Host " Other: $stopped" -ForegroundColor Red Write-Host " Compute: $compute | Databases: $dbs | Load Balancers: $lbs" # --- 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 "OCI-Dashboard-Template.html" Export-OCIDashboardHtml -DashboardData $dashboardData -OutputPath $htmlPath -ReportTitle "OCI Dashboard" -TemplatePath $templatePath Write-Host "HTML dashboard written to $htmlPath" -ForegroundColor Yellow # --- Optional: Open in browser ----------------------------------------------- if ($env:OS -match 'Windows') { $openBrowser = Read-Host -Prompt "Open dashboard in browser? (Y/N)" if ($openBrowser -match '^[Yy]') { Start-Process $htmlPath } } Write-Host "Done." -ForegroundColor Green # SIG # Begin signature block # MIIVlwYJKoZIhvcNAQcCoIIViDCCFYQCAQExDzANBglghkgBZQMEAgEFADB5Bgor # BgEEAYI3AgEEoGswaTA0BgorBgEEAYI3AgEeMCYCAwEAAAQQH8w7YFlLCE63JNLG # KX7zUQIBAAIBAAIBAAIBAAIBADAxMA0GCWCGSAFlAwQCAQUABCBFG0vwRx098Kjh # bZ+Rri+J9Hh0X1DND16phxCo2QaZ96CCEdMwggVvMIIEV6ADAgECAhBI/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 # BAGCNwIBFTAvBgkqhkiG9w0BCQQxIgQglDHvnqyFwVzJHw0hd5W2JcSNK8hjDMY1 # lWHZFrSeuFEwDQYJKoZIhvcNAQEBBQAEggIAK6S0NxQyNKvo62qCvL8wJ+VSj4Ft # LnumhaDI9URDjUdTlJypgQLPLM9+CIaW4MDgfZHL4+hmgZnoRt8u2uhSBb8zP63d # rRzeNPsb7dzdFN1TmgSz7sFYskPoV5H4XU+wxj+fI+LYAgqA7EqNJGRgceTgrCFV # E4LY0z6otMnGQzE0KU0sRXsaU8l3I2nn3/NqhXeoSVj0hEq9p7ZVwTKQRk1k0Utc # KUeq701k9kgUfJdY1xyCcdi1vJXkIEZKmUTBnKfmd8J5rBkAXsQVbOg0NQqyyUlY # fJTkUzDWJPJD07Fat0wrR8qURFS/IurlddSHeGPGyWjAjMkS5DBJS8OY/SYzJGMt # uUIUy/XEZj9re6U0qUbW+kAPuOP961ZM/sOUlKQaO+NkITAvIhiJ1FD/Kt9sjC49 # V9YjVkZjn5o29LLex6uNbk4wELr9y+MamS7lso7/ckF26979u52uXZJB6S9LrTVN # YS3ayzOipmtTPLVhRqj8baDCmMYN45dbLg13r7RpVgqNUp1JbeslnY0nzgNH6A2v # yCkEvHo2dlKwdSbBUytoQ1bWbFjnqT4jMravIZdH/BwPx5k4lAyMrXa+Qax4jeFs # 71Pj1KY3cHoC7rxScHElLSZluUTDRXdwYaWHoY8FFFLFSEIM4mlTqtyXwgDRxQBb # C6ZzlBCxWiGHkWM= # SIG # End signature block |