Start-AzureRmSiteRecoveryUnplannedFailoverJob

Starts the unplanned failover for a Site Recovery protection entity or recovery plan.

Important

Because Az PowerShell modules now have all the capabilities of AzureRM PowerShell modules and more, we'll retire AzureRM PowerShell modules on 29 February 2024.

To avoid service interruptions, update your scripts that use AzureRM PowerShell modules to use Az PowerShell modules by 29 February 2024. To automatically update your scripts, follow the quickstart guide.

Syntax

Start-AzureRmSiteRecoveryUnplannedFailoverJob
     -ProtectionEntity <ASRProtectionEntity>
     -Direction <String>
     [-PerformSourceSideActions]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]
Start-AzureRmSiteRecoveryUnplannedFailoverJob
     -RecoveryPlan <ASRRecoveryPlan>
     -Direction <String>
     [-PerformSourceSideActions]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]
Start-AzureRmSiteRecoveryUnplannedFailoverJob
     -ReplicationProtectedItem <ASRReplicationProtectedItem>
     -Direction <String>
     [-PerformSourceSideActions]
     [-DataEncryptionPrimaryCertFile <String>]
     [-DataEncryptionSecondaryCertFile <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [<CommonParameters>]

Description

The Start-AzureRmSiteRecoveryUnplannedFailoverJob cmdlet starts the unplanned failover of an Azure Site Recovery protection entity or recovery plan. You can check whether the job succeeds by using the Get-AzureRmSiteRecoveryJob cmdlet.

Parameters

-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
-DefaultProfile

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

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

Specifies the direction of the failover. 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
-PerformSourceSideActions

Indicates that the action can perform source site operations.

Type:SwitchParameter
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
Accept wildcard characters:False
-RecoveryPlan

Specifies a recovery plan object.

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

Inputs

ASRProtectionEntity

Parameter 'ProtectionEntity' accepts value of type 'ASRProtectionEntity' from the pipeline

ASRRecoveryPlan

Parameter 'RecoveryPlan' accepts value of type 'ASRRecoveryPlan' from the pipeline

ASRReplicationProtectedItem

Parameter 'ReplicationProtectedItem' accepts value of type 'ASRReplicationProtectedItem' from the pipeline

Outputs

Microsoft.Azure.Commands.SiteRecovery.ASRJob