Add support for additional connectivity health checks

[tenthirtyam]

Code of Conduct

• I have read and agree to the project's Code of Conduct.
• Vote on this issue by adding a 👍 reaction to the original issue initial description to help the maintainers prioritize.
• Do not leave "+1" or other comments that do not add relevant information or questions.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Description

Add support for including the results of "Connectivity": { "Ping Status": { in the Connectivity Health section of the Health Report.

Use Case(s)

Provides the status of ICMP requests to the IP of:

• Platform Components (vCenter Server, ESXi Hosts, NSX Managers (Local)
• vRealize Suite Components, if in VCF-mode.

Potential Configuration

To be determined.

References

Example JSON

    "Connectivity": {
        "Ping Status": {
            "sfo01-w01-esx01.sfo.rainpole.io": {
                "172.18.103.101": {
                    "area": "ESXi : sfo01-w01-esx01.sfo.rainpole.io",
                    "title": "Ping status",
                    "state": "REACHABLE",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "Ping successful!",
                    "status": "passed",
                    "alert": "GREEN"
                }
            },
            "sfo01-w01-esx03.sfo.rainpole.io": {
                "172.18.103.103": {
                    "area": "ESXi : sfo01-w01-esx03.sfo.rainpole.io",
                    "title": "Ping status",
                    "state": "REACHABLE",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "Ping successful!",
                    "status": "passed",
                    "alert": "GREEN"
                }
            },
            "sfo01-w01-esx04.sfo.rainpole.io": {
                "172.18.103.104": {
                    "area": "ESXi : sfo01-w01-esx04.sfo.rainpole.io",
                    "title": "Ping status",
                    "state": "REACHABLE",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "Ping successful!",
                    "status": "passed",
                    "alert": "GREEN"
                }
            },
            "sfo-w01-vc01.sfo.rainpole.io": {
                "area": "vCenter : sfo-w01-vc01.sfo.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "172.18.95.131": {
                "area": "NSX: sfo-w01-nsx01.sfo.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-vra01a.rainpole.io": {
                "area": "VRA : xint-vra01a.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-vra01b.rainpole.io": {
                "area": "VRA : xint-vra01b.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-vra01c.rainpole.io": {
                "area": "VRA : xint-vra01c.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-vrslcm01.rainpole.io": {
                "area": "VRSLCM : xint-vrslcm01.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "sfo-vrli01a.sfo.rainpole.io": {
                "area": "vRLI : sfo-vrli01a.sfo.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "sfo-vrli01b.sfo.rainpole.io": {
                "area": "vRLI : sfo-vrli01b.sfo.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "sfo-vrli01c.sfo.rainpole.io": {
                "area": "vRLI : sfo-vrli01c.sfo.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-vrops01a.rainpole.io": {
                "area": "vROps : xint-vrops01a.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-vrops01b.rainpole.io": {
                "area": "vROps : xint-vrops01b.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "sfo-vropsc01a.sfo.rainpole.io": {
                "area": "vROps : sfo-vropsc01a.sfo.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "sfo-vropsc01b.sfo.rainpole.io": {
                "area": "vROps : sfo-vropsc01b.sfo.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-vrops01c.rainpole.io": {
                "area": "vROps : xint-vrops01c.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-wsa01a.rainpole.io": {
                "area": "WSA : xint-wsa01a.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:16 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-wsa01b.rainpole.io": {
                "area": "WSA : xint-wsa01b.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:16 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-wsa01c.rainpole.io": {
                "area": "WSA : xint-wsa01c.rainpole.io",
                "title": "Ping status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:16 2022",
                "message": "Ping successful!",
                "status": "passed",
                "alert": "GREEN"
            }
        },
        "Connectivity Status": {
            "ESXi API Status": {
                "sfo01-w01-esx01.sfo.rainpole.io": {
                    "area": "ESXi : sfo01-w01-esx01.sfo.rainpole.io",
                    "title": "API Connectivity status",
                    "state": "REACHABLE",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "API Connectivity check successful!",
                    "status": "passed",
                    "alert": "GREEN"
                },
                "sfo01-w01-esx03.sfo.rainpole.io": {
                    "area": "ESXi : sfo01-w01-esx03.sfo.rainpole.io",
                    "title": "API Connectivity status",
                    "state": "REACHABLE",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "API Connectivity check successful!",
                    "status": "passed",
                    "alert": "GREEN"
                },
                "sfo01-w01-esx04.sfo.rainpole.io": {
                    "area": "ESXi : sfo01-w01-esx04.sfo.rainpole.io",
                    "title": "API Connectivity status",
                    "state": "REACHABLE",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "API Connectivity check successful!",
                    "status": "passed",
                    "alert": "GREEN"
                }
            },
            "ESXi SSH Status": {
                "sfo01-w01-esx01.sfo.rainpole.io": {
                    "area": "ESXi : sfo01-w01-esx01.sfo.rainpole.io",
                    "title": "** SSH status is disabled.",
                    "state": "NOT_RUNNING",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "** SSH status is disabled.",
                    "status": "passed",
                    "alert": "-"
                },
                "sfo01-w01-esx03.sfo.rainpole.io": {
                    "area": "ESXi : sfo01-w01-esx03.sfo.rainpole.io",
                    "title": "** SSH status is disabled.",
                    "state": "NOT_RUNNING",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "** SSH status is disabled.",
                    "status": "passed",
                    "alert": "-"
                },
                "sfo01-w01-esx04.sfo.rainpole.io": {
                    "area": "ESXi : sfo01-w01-esx04.sfo.rainpole.io",
                    "title": "** SSH status is disabled.",
                    "state": "NOT_RUNNING",
                    "timestamp": "Mon Dec  5 23:24:10 2022",
                    "message": "** SSH status is disabled.",
                    "status": "passed",
                    "alert": "-"
                }
            },
            "sfo-w01-vc01.sfo.rainpole.io": {
                "area": "vCenter : sfo-w01-vc01.sfo.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "sfo-w01-nsx01.sfo.rainpole.io": {
                "area": "NSX: sfo-w01-nsx01.sfo.rainpole.io",
                "title": "API Connectivity status",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "API Connection check successful!",
                "status": "passed",
                "alert": "GREEN"
            },
            "xint-vrslcm01.rainpole.io": {
                "area": "VRSLCM : xint-vrslcm01.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "sfo-vrli01a.sfo.rainpole.io": {
                "area": "VRLI : sfo-vrli01a.sfo.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "sfo-vrli01b.sfo.rainpole.io": {
                "area": "VRLI : sfo-vrli01b.sfo.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "sfo-vrli01c.sfo.rainpole.io": {
                "area": "VRLI : sfo-vrli01c.sfo.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-vra01a.rainpole.io": {
                "area": "VRA : xint-vra01a.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-vra01b.rainpole.io": {
                "area": "VRA : xint-vra01b.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-vra01c.rainpole.io": {
                "area": "VRA : xint-vra01c.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-vrops01a.rainpole.io": {
                "area": "vROps : xint-vrops01a.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-vrops01b.rainpole.io": {
                "area": "vROps : xint-vrops01b.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "sfo-vropsc01a.sfo.rainpole.io": {
                "area": "vROps : sfo-vropsc01a.sfo.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "sfo-vropsc01b.sfo.rainpole.io": {
                "area": "vROps : sfo-vropsc01b.sfo.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-vrops01c.rainpole.io": {
                "area": "vROps : xint-vrops01c.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:10 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-wsa01a.rainpole.io": {
                "area": "WSA : xint-wsa01a.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-wsa01b.rainpole.io": {
                "area": "WSA : xint-wsa01b.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            },
            "xint-wsa01c.rainpole.io": {
                "area": "WSA : xint-wsa01c.rainpole.io",
                "title": "** SSH status is enabled.",
                "state": "REACHABLE",
                "timestamp": "Mon Dec  5 23:24:13 2022",
                "message": "** SSH status is enabled.",
                "status": "passed",
                "alert": "-"
            }
        }
    },

[tenthirtyam]

Quick example, but it will skip the ESXi host - needs additional logic to address JSON consistencies.

Function Publish-PingConnectivityHealth {
    <#
        .SYNOPSIS
        Formats the PingConnectivity Health data from the SoS JSON output.

        .DESCRIPTION
        The Publish-PingConnectivityHealth cmdlet formats the Connectivity Health data from the SoS JSON output and
        publishes it as either a standard PowerShell object or an HTML object.

        .EXAMPLE
        Publish-PingConnectivityHealth -json <file-name>
        This example extracts and formats the Ping Connectivity Health data as a PowerShell object from the JSON file.

        .EXAMPLE
        Publish-PingConnectivityHealth -json <file-name> -html
        This example extracts and formats the Ping Connectivity Health data as an HTML object from the JSON file.

        .EXAMPLE
        Publish-PingConnectivityHealth -json <file-name> -failureOnly
        This example extracts and formats the Ping Connectivity Health data as a PowerShell object from the JSON file for only the failed items.
    #>

    Param (
        [Parameter (Mandatory = $true)] [ValidateNotNullOrEmpty()] [String]$json,
        [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [Switch]$html,
        [Parameter (Mandatory = $false)] [ValidateNotNullOrEmpty()] [Switch]$failureOnly
    )

    Try {
        if (!(Test-Path -Path $json)) {
            Write-Error "Unable to find JSON file at location ($json)" -ErrorAction Stop
        } else {
            $targetContent = Get-Content $json | ConvertFrom-Json
        }

        $customObject = New-Object System.Collections.ArrayList
        $jsonInputData = $targetContent.Connectivity.'Ping Status'
        if (($jsonInputData | Measure-Object).Count -lt 1) {
            Write-Warning 'Ping Status data not found in the JSON file: SKIPPED'
        } else {
            $esxiHosts = Get-VCFHost
            foreach ($esxiHost in $esxiHosts) {
                $jsonInputData.PSObject.Properties.Remove($esxiHost.fqdn)
            }
            $jsonInputData = $targetContent.Connectivity.'Ping Status'
            if ($PsBoundParameters.ContainsKey('failureOnly')) {
                $outputObject = Read-JsonElement -inputData $jsonInputData -failureOnly
            } else {
                $outputObject = Read-JsonElement -inputData $jsonInputData
            }
            $customObject += $outputObject
        }

        # Return the structured data to the console or format using HTML CSS Styles
        if ($PsBoundParameters.ContainsKey('html')) {
            if (($jsonInputData | Measure-Object).Count -gt 0) {
                if ($outputObject.Count -eq 0) { $addNoIssues = $true }
                if ($addNoIssues) {
                    $customObject = $customObject | Sort-Object Component, Resource | ConvertTo-Html -Fragment -PreContent '<a id="general-ping-connectivity"></a><h3>Ping Connectivity Health Status</h3>' -PostContent '<p>No issues found.</p>'
                } else {
                    $customObject = $customObject | Sort-Object Component, Resource | ConvertTo-Html -Fragment -PreContent '<a id="general-ping-connectivity"></a><h3>Ping Connectivity Health Status</h3>' -As Table
                }
                $customObject = Convert-CssClass -htmldata $customObject
            } else {
                $customObject = $customObject | Sort-Object Component, Resource | ConvertTo-Html -Fragment -PreContent '<a id="general-ping-connectivity"></a><h3>Ping Connectivity Health Status</h3>' -PostContent '<p><strong>WARNING</strong>: Ping Status data not found.</p>' -As Table
            }
            $customObject
        } else {
            $customObject | Sort-Object Component, Resource
        }
    }
    Catch {
        Debug-CatchWriter -object $_
    }
}

[github-actions]

'Marking this issue as stale due to inactivity. This helps us focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed.

If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context.
Thank you!'