< Back
Start-AzureSiteRecoveryPlannedFailoverJob
Post
NAME Start-AzureSiteRecoveryPlannedFailoverJob
SYNOPSIS
Start the Planned Failover operation for a Protection Entity or Recovery Plan under Azure Site Recovery
SYNTAX
Start-AzureSiteRecoveryPlannedFailoverJob -Direction <string> -RecoveryPlan <ASRRecoveryPlan> [-Optimize <string>] [-WaitForCompletion]
[<CommonParameters>]
Start-AzureSiteRecoveryPlannedFailoverJob -Direction <string> -RpId <string> [-Optimize <string>] [-WaitForCompletion] [<CommonParameters>]
Start-AzureSiteRecoveryPlannedFailoverJob -Direction <string> -ProtectionEntity <ASRProtectionEntity> [-Optimize <string>] [-WaitForCompletion]
[<CommonParameters>]
Start-AzureSiteRecoveryPlannedFailoverJob -Direction <string> -ProtectionContainerId <string> -ProtectionEntityId <string> [-Optimize <string>]
[-WaitForCompletion] [<CommonParameters>]
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
Required? true
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProtectionContainerId <string>
Id of the Protection Container
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProtectionEntity <ASRProtectionEntity>
Protection Entity object
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ProtectionEntityId <string>
Id of the Protection Entity
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RecoveryPlan <ASRRecoveryPlan>
Recovery Plan object
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-RpId <string>
Id of the Recovery Plan
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WaitForCompletion [<SwitchParameter>]
Waits till the operation completes
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Keywords: azure, azuresm, servicemanagement, management, service, site, recovery
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>$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 : {}
Description
-----------
RELATED LINKS
SYNOPSIS
Start the Planned Failover operation for a Protection Entity or Recovery Plan under Azure Site Recovery
SYNTAX
Start-AzureSiteRecoveryPlannedFailoverJob -Direction <string> -RecoveryPlan <ASRRecoveryPlan> [-Optimize <string>] [-WaitForCompletion]
[<CommonParameters>]
Start-AzureSiteRecoveryPlannedFailoverJob -Direction <string> -RpId <string> [-Optimize <string>] [-WaitForCompletion] [<CommonParameters>]
Start-AzureSiteRecoveryPlannedFailoverJob -Direction <string> -ProtectionEntity <ASRProtectionEntity> [-Optimize <string>] [-WaitForCompletion]
[<CommonParameters>]
Start-AzureSiteRecoveryPlannedFailoverJob -Direction <string> -ProtectionContainerId <string> -ProtectionEntityId <string> [-Optimize <string>]
[-WaitForCompletion] [<CommonParameters>]
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
Required? true
Position? named
Default value
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProtectionContainerId <string>
Id of the Protection Container
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProtectionEntity <ASRProtectionEntity>
Protection Entity object
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ProtectionEntityId <string>
Id of the Protection Entity
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RecoveryPlan <ASRRecoveryPlan>
Recovery Plan object
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-RpId <string>
Id of the Recovery Plan
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WaitForCompletion [<SwitchParameter>]
Waits till the operation completes
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Keywords: azure, azuresm, servicemanagement, management, service, site, recovery
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>$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 : {}
Description
-----------
RELATED LINKS