Start-​Azure​Rm​Site​Recovery​Planned​Failover​Job

Starts a Site Recovery planned failover operation.

Syntax

Start-AzureRmSiteRecoveryPlannedFailoverJob
     [-CreateVmIfNotFound <String>]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     -Direction <String>
     [-Optimize <String>]
     -ProtectionEntity <ASRProtectionEntity>
     [-Server <ASRServer>]
     [<CommonParameters>]
Start-AzureRmSiteRecoveryPlannedFailoverJob
     [-CreateVmIfNotFound <String>]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     -Direction <String>
     [-Optimize <String>]
     -RecoveryPlan <ASRRecoveryPlan>
     [<CommonParameters>]
Start-AzureRmSiteRecoveryPlannedFailoverJob
     [-CreateVmIfNotFound <String>]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     -Direction <String>
     [-Optimize <String>]
     -ReplicationProtectedItem <ASRReplicationProtectedItem>
     [-ServicesProvider <ASRRecoveryServicesProvider>]
     [<CommonParameters>]

Description

The Start-AzureRmSiteRecoveryPlannedFailoverJob cmdlet starts a planned failover for an Azure Site Recovery protection entity or recovery plan. You can check whether the job succeeds by using the Get-AzureRmSiteRecoveryJob cmdlet.

Required Parameters

-Direction

Specifies the direction of the failover. The acceptable values for this parameter are:

  • PrimaryToRecovery
  • RecoveryToPrimary
Type:String
Parameter Sets:PrimaryToRecovery, RecoveryToPrimary
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProtectionEntity

Specifies the Site Recovery protection entity object.

Type:ASRProtectionEntity
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-RecoveryPlan

Specifies a recovery plan object.

Type:ASRRecoveryPlan
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-ReplicationProtectedItem
Type:ASRReplicationProtectedItem
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-CreateVmIfNotFound

The acceptable values for this parameter are:

  • Yes
  • No
Type:String
Parameter Sets:Yes, No
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DataEncryptionPrimaryCertFile

Specifies the primary certificate file.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DataEncryptionSecondaryCertFile

Specifies the secondary certificate file.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Optimize

Specifies what to optimize for. This parameter applies when failover is done from an Azure site to an on-premise site which requires a substantial data synchronization. Valid values are:

  • ForDowntime
  • ForSynchronization

When ForDowntime is specified, this indicates that data is synchronized before failover to minimize downtime. Synchronization is performed without shutting down the virtual machine. After synchronization is complete, the job is suspended. Resume the job to do an additional synchronization operation that shuts down the virtual machine.

When ForSynchronization is specified, this indicates that data is synchronized during failover only so data synchronization is minimized. With this setting enabled, the virtual machine is shut down immediately. Synchronization starts after shutdown to complete the failover operation.

Type:String
Parameter Sets:ForDownTime, ForSynchronization
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Server
Type:ASRServer
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServicesProvider
Type:ASRRecoveryServicesProvider
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False