Get-VsanEvacuationPlan Command | Vmware PowerCLI Reference

Get-VsanEvacuationPlan

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Entity VIObjectCore[] named
  • pipeline
  • wildcards
Specifies the entity for which you want to retrieve evacuation information. This parameter accepts VMHost, VsanDisk, VsanDiskGroup, and VsanStoragePoolDisk(vSphere 8.0 and later) entity types. OBN and wildcard are supported for VMHost type only.
optional EvacuationMode VsanDataMigrationMode[] named
Filters the results by data migration mode options.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.

Output

VMware.VimAutomation.Storage.Types.V1.Vsan.VsanEvacuationPlan

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.

Example 3

Get-VsanEvacuationPlan -Entity $vsanStoragePoolDisk -EvacuationPlan Full

Retrieves the evacuation plan about removing the $vsanStoragePoolDisk vSAN storage pool disk for vSAN full data migration mode. Note: The VsanStoragePoolDisk entity type is available from vSphere 8.0.

Related Commands

VsanEvacuationPlan

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