PowerCLI Reference

Get-VsanEnterMaintenanceModeReport

Synopsis

This cmdlet retrieves the report of capacity or objects which may have accessbility or compliance issues, if a virtual machine host enters maintenance mode.

Syntax

Get-VsanEnterMaintenanceModeReport [-AccessibleAndCompliant] -VMHost <VMHost> -VsanDataMigrationMode <String> [-Server <VIServer[]>] [<CommonParameters>]

Get-VsanEnterMaintenanceModeReport [-Capacity] -VMHost <VMHost> -VsanDataMigrationMode <String> [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet retrieves the report of capacity or objects which may have accessbility or compliance issues, if a virtual machine host enters maintenance mode. The report data includes: 1. Overall state: The possible statuses are: Green - resource check passed for the queried operation. There is sufficient resource in the vSAN cluster to perform the queried operation. Yellow - resource check passed for the queried operation, but there is an existing issue in the cluster, for example, network partition. Red - resource check failed for the queried operation. Extra resource is required to make the given operation succeed. 2. Each virtual machine host's capacity report for the Capacity parameter set. 3. Objects which may have accessbility or compliance issues for the AccessibleAndCompliant parameter set.

Parameters

Name	Type	Description	Required?	Pipeline Input
AccessibleAndCompliant	SwitchParameter	If specified, retrieves inaccessible or noncompliant objects.	false	False
Capacity	SwitchParameter	If specified, retrieves details of the resource check.	false	False
Server	VIServer[]	Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.	false	False
VMHost	VMHost	Specifies the virtual machine host that enters the maintenance mode.	true	True
VsanDataMigrationMode	String	Specifies the vSAN data migration mode. The valid values are: ensureObjectAccessibility: The vSAN data reconfiguration should be performed to ensure storage object accessibility. evacuateAllData: The vSAN data evacuation should be performed in such a way that you can remove all storage object data from the virtual machine host. noAction: No special action should take place regarding the vSAN data.	true	False

Return Type

One VsanEnterMaintenanceModeReport

Notes

Works only with vCenter Server vSAN 6.7 Update 3 or later. For more information, see the VMware Storage Policy API Reference: https://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vspsdk.apiref.doc/right-pane.html

Examples

-------------------------- Example 1 --------------------------

Get-VsanEnterMaintenanceModeReport -VMHost $vmHost -AccessibleAndCompliant

Retrieves one VsanEnterMaintenanceModeReport with objects which may have accessbility or compliance issues.

-------------------------- Example 2 --------------------------

Get-VsanEnterMaintenanceModeReport -VMHost $vmHost -Capacity

Retrieves one VsanEnterMaintenanceModeReport with each virtual machine host's capacity report.