Start-AzRecoveryServicesAsrUnplannedFailoverJob

Reference

Module:: Az.RecoveryServices

Starts an unplanned failover operation.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Start-AzRecoveryServicesAsrUnplannedFailoverJob
     -ReplicationProtectedItem <ASRReplicationProtectedItem>
     -Direction <String>
     [-PerformSourceSideAction]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     [-RecoveryPoint <ASRRecoveryPoint>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzRecoveryServicesAsrUnplannedFailoverJob
     -RecoveryPlan <ASRRecoveryPlan>
     -Direction <String>
     [-PerformSourceSideAction]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     [-RecoveryTag <String>]
     [-MultiVmSyncPoint <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzRecoveryServicesAsrUnplannedFailoverJob
     -ReplicationProtectedItem <ASRReplicationProtectedItem>
     -Direction <String>
     [-PerformSourceSideAction]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     -RecoveryTag <String>
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-AzRecoveryServicesAsrUnplannedFailoverJob cmdlet starts unplanned failover of an Azure Site Recovery replication protected item or recovery plan. You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet.

Examples

Example 1

$currentJob = Start-AzRecoveryServicesAsrUnplannedFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery -VMNetwork $RecoveryNetwork

Starts the unplanned failover operation for the recovery plan with the specified parameters and returns the ASR job used to track the operation.

Example 2

Starts an unplanned failover operation. (autogenerated)

Start-AzRecoveryServicesAsrUnplannedFailoverJob -Direction PrimaryToRecovery -RecoveryPoint $rp[0] -ReplicationProtectedItem $ReplicationProtectedItem

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DataEncryptionPrimaryCertFile

Specifies the data encryption primary certificate file path for failover of Protected Item.

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

-DataEncryptionSecondaryCertFile

Specifies the data encryption secondary certificate file path for failover of Protected Item.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Direction

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

PrimaryToRecovery
RecoveryToPrimary

Type:	String
Accepted values:	PrimaryToRecovery, RecoveryToPrimary
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-MultiVmSyncPoint

Specifies whether to enable multi VM sync points for failover of multi VM sync enabled VMs (Applicable only for VMware to Azure replication scenario).

Type:	String
Accepted values:	Enable, Disable
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-PerformSourceSideAction

Perform operation in source side before starting unplanned failover.

Type:	SwitchParameter
Aliases:	PerformSourceSideActions
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-RecoveryPlan

Specifies an ASR recovery plan object.

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

-RecoveryPoint

Specifies a custom recovery point to failover the protected machine to. If not specified, ASR will process the pending writes and pick the latest recovery point (lowest RPO).

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

-RecoveryTag

Specifies the recovery tag to failover to.

Type:	String
Accepted values:	Latest, LatestAvailable, LatestAvailableApplicationConsistent, LatestAvailableCrashConsistent, Latest, LatestAvailable, LatestAvailableApplicationConsistent, LatestAvailableCrashConsistent
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False