Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Start-AzureSiteRecoveryPlannedFailoverJob

Start-AzureSiteRecoveryPlannedFailoverJob

microsoft.azure.commands.recoveryservices.dll

Synopsis

Start the Planned Failover operation for a Protection Entity or Recovery Plan under Azure Site Recovery

Syntax

Start-AzureSiteRecoveryPlannedFailoverJob [-Direction] [-RecoveryPlan] [-Optimize] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryPlannedFailoverJob [-Direction] [-RpId] [-Optimize] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryPlannedFailoverJob [-Direction] [-ProtectionEntity] [-Optimize] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryPlannedFailoverJob [-Direction] [-ProtectionContainerId] [-ProtectionEntityId] [-Optimize] [-WaitForCompletion] [<CommonParameters>]

Detailed Description

Start the Planned Failover operation for a Protection Entity or Recovery Plan under Azure Site Recovery. This will start the failover and return the job object. Success of the job can be tracked using Get-AzureSiteRecoveryJob

Parameters

-Direction <string>

Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Optimize <string>

This parameter is applicable when Failover is done from Azure to on-premise site which requires a large data synchronization. Specify what synchronization has to optimize: ForDowntime: Synchronize data before failover (minimize downtime) Synchronization will be performed without shutting down the virtual machine. After synchronization is complete, the job would be suspended. Resume the job to do an additional synchronization that shuts down the virtual machine. ForSynchronization : data during failover only (minimize synchronization) With this setting enabled, the virtual machine will begin shutdown immediately. Synchronization will start after shutdown to complete the failover.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ProtectionContainerId <string>

Id of the Protection Container

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ProtectionEntity <ASRProtectionEntity>

Protection Entity object

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-ProtectionEntityId <string>

Id of the Protection Entity

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RecoveryPlan <ASRRecoveryPlan>

Recovery Plan object

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-RpId <string>

Id of the Recovery Plan

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-WaitForCompletion <SwitchParameter>

Waits till the operation completes

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>

Description

-----------

          $PC = Get-AzureSiteRecoveryProtectionContainer; $PE = Get-AzureSiteRecoveryProtectionEntity -ProtectionContainer $PC; Start-AzureSiteRecoveryPlannedFailoverJob -ProtectionEntity $PE -Direction PrimaryToRecovery -Optimize ForDowntime

          ID               : c38eecdc-731c-405b-a61c-08db99aae2fe
          ClientRequestId  : 32ace403-0916-4967-83a1-529176bd6e88-2014-49-06 15:49:24Z-P
          State            : NotStarted
          StateDescription : NotStarted
          StartTime        :
          EndTime          :
          AllowedActions   : {}
          Name             :
          Tasks            : {}
          Errors           : {}