Files
ZertoApiWrapper/docs/Invoke-ZertoEvacuateVra.md
T
2020-04-02 10:48:02 -04:00

3.4 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
ZertoApiWrapper-help.xml ZertoApiWrapper https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Invoke-ZertoEvacuateVra.md 2.0.0

Invoke-ZertoEvacuateVra

SYNOPSIS

This operation will move all VMs currently replicating to the selected host or VRA to different hosts based on internal Zerto algorithms.

SYNTAX

VraIdentifier (Default)

Invoke-ZertoEvacuateVra -VraIdentifier <String> [-WhatIf] [-Confirm] [<CommonParameters>]

HostName

Invoke-ZertoEvacuateVra -HostName <String> [-WhatIf] [-Confirm] [<CommonParameters>]

VraName

Invoke-ZertoEvacuateVra -VraName <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This operation will move all VMs currently replicating to the selected host or VRA to different hosts based on internal Zerto algorithms.

This will return a Zerto Task Identifier so the task progress can be tracked.

EXAMPLES

Example 1

PS C:\> Invoke-ZertoEvacuateVra -HostName 'host01'

Will move all VMs currently replicating to the selected host to different hosts.

Example 2

PS C:\> Invoke-ZertoEvacuateVra -VraName 'Z-VRA-host01'

Will move all VMs currently replicating to the selected VRA to different VRAs.

Example 3

PS C:\> Invoke-ZertoEvacuateVra -VraIdentifier '1234-1234-4312-9856'

Will move all VMs currently replicating to the selected VRA to different VRAs.

PARAMETERS

-HostName

HostName Option

Type: String
Parameter Sets: HostName
Aliases:

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

-VraIdentifier

VRAIdentifier Option

Type: String
Parameter Sets: VraIdentifier
Aliases: VraId, Identifier

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-VraName

VRA Option

Type: String
Parameter Sets: VraName
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

Zerto REST API Evacuate VRA End Point Documentation