Skip to content

Get-vSANHealthSummary

Synopsis

Retrieves the vSAN health summary from vCenter Server for a cluster.

Syntax

Get-vSANHealthSummary [-server] <String> [-user] <String> [-pass] <String> [-domain] <String> [-cluster] <String> [<CommonParameters>]

Description

The Get-vSANHealthSummary cmdlet gets the vSAN health summary from vCenter Server for a cluster.

If any status is YELLOW or RED, a WARNING or ERROR will be raised.

Examples

Example 1

Get-vSANHealthSummary -server sfo-vcf01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -domain sfo-m01 -cluster sfo-m01-cl01

This example gets the vSAN health summary for cluster sfo-m01-cl01.

Parameters

-server

The fully qualified domain name of the SDDC Manager instance.

Type: String
Parameter Sets: (All)
Aliases:

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

-user

The username to authenticate to the SDDC Manager instance.

Type: String
Parameter Sets: (All)
Aliases:

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

-pass

The password to authenticate to the SDDC Manager instance.

Type: String
Parameter Sets: (All)
Aliases:

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

-domain

The name of the workload domain in which the cluster is located.

Type: String
Parameter Sets: (All)
Aliases:

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

-cluster

The name of the cluster to retrieve the vSAN health summary for.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
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.