Start-VCFHealthSummary

Synopsis

Starts the Health Summary checks.

Syntax

Start-VCFHealthSummary [-json] <String> [<CommonParameters>]

Description

The Start-VCFHealthSummary cmdlet starts the Health Summary checks.

Examples

Example 1

Start-VCFHealthSummary -json (Get-Content -Raw .\samples\sos\healthSummarySpec.json)

This example shows how to start the Health Summary checks using the JSON specification file.

Sample JSON: Start Health Summary

{
    "healthChecks": {
        "certificateHealth": true,
        "composabilityHealth": true,
        "computeHealth": true,
        "connectivityHealth": true,
        "dnsHealth": true,
        "generalHealth": true,
        "hardwareCompatibilityHealth": true,
        "ntpHealth": true,
        "passwordHealth": true,
        "servicesHealth": true,
        "storageHealth": true
    },
    "options": {
        "config": {
        "force": false,
        "skipKnownHostCheck": false
    },
    "include": {
        "summaryReport": true
    }
    },
    "scope": {
        "domains": [
        {
            "clusterNames": [""],
            "domainName": ""
        }
        ],
        "includeAllDomains": true,
        "includeFreeHosts": true
    }
}

Parameters

-json

Specifies the JSON specification to be used.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

---

Last update: 2023-09-12