PowerCLI Reference

Get-VsanEvacuationPlan

Synopsis

This cmdlet retrieves information about the entity (disk, disk group, or host) you want to evacuate in various modes.

Syntax

Get-VsanEvacuationPlan [-Entity] <VIObjectCore[]> [-EvacuationMode <VsanDataMigrationMode[]>] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet retrieves information about the entity (disk, disk group, or host) you want to evacuate in various modes. You receive information about capacity usage only when the cmdlet determines that an entity can be evacuated in a given mode.

Parameters

Name	Type	Description	Required?	Pipeline Input
Entity	VIObjectCore[]	Specifies the entity for which you want to retrieve evacuation information. This parameter accepts VMHost, VsanDisk, and VsanDiskGroup entity types. OBN and wildcard are supported for VMHost type only.	true	True (ByValue)
EvacuationMode	VsanDataMigrationMode[]	Filters the results by data migration mode options.	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 Connect-VIServer.	false	False

Return Type

Zero or more VsanEvacuationPlan objects

Notes

Examples

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

Get-VsanEvacuationPlan -Entity $vmHost

Retrieves the evacuation plan about removing the $vmHost virtual machine host from the cluster.

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

Get-VsanEvacuationPlan -Entity $diskGroup -EvacuationPlan Full

Retrieves the evacuation plan about removing the $diskGroup vSAN disk group for vSAN full data migration mode.