Edit

Share via

Start-AzureSiteRecoveryTestFailoverJob

  • Reference
Module:
Azure

Starts a test failover for a Site Recovery protection entity.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     -ProtectionEntityId <String>
     -ProtectionContainerId <String>
     [-WaitForCompletion]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     -RpId <String>
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     [-WaitForCompletion]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     -RpId <String>
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     [-WaitForCompletion]
     -LogicalNetworkId <String>
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     -RpId <String>
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     [-WaitForCompletion]
     -VmNetworkId <String>
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     -RpId <String>
     -Network <ASRNetwork>
     [-NetworkType <String>]
     -Direction <String>
     [-WaitForCompletion]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     -Network <ASRNetwork>
     [-NetworkType <String>]
     -Direction <String>
     -ProtectionEntity <ASRProtectionEntity>
     [-WaitForCompletion]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     -Network <ASRNetwork>
     [-NetworkType <String>]
     -RecoveryPlan <ASRRecoveryPlan>
     -Direction <String>
     [-WaitForCompletion]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     -Network <ASRNetwork>
     [-NetworkType <String>]
     -Direction <String>
     -ProtectionEntityId <String>
     -ProtectionContainerId <String>
     [-WaitForCompletion]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -RecoveryPlan <ASRRecoveryPlan>
     -Direction <String>
     [-WaitForCompletion]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -RecoveryPlan <ASRRecoveryPlan>
     -Direction <String>
     [-WaitForCompletion]
     -LogicalNetworkId <String>
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -RecoveryPlan <ASRRecoveryPlan>
     -Direction <String>
     [-WaitForCompletion]
     -VmNetworkId <String>
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     -ProtectionEntityId <String>
     -ProtectionContainerId <String>
     [-WaitForCompletion]
     -LogicalNetworkId <String>
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     -ProtectionEntityId <String>
     -ProtectionContainerId <String>
     [-WaitForCompletion]
     -VmNetworkId <String>
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     -ProtectionEntity <ASRProtectionEntity>
     [-WaitForCompletion]
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     -ProtectionEntity <ASRProtectionEntity>
     [-WaitForCompletion]
     -LogicalNetworkId <String>
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]
Start-AzureSiteRecoveryTestFailoverJob
     [-Network <ASRNetwork>]
     [-NetworkType <String>]
     -Direction <String>
     -ProtectionEntity <ASRProtectionEntity>
     [-WaitForCompletion]
     -VmNetworkId <String>
     [-Profile <AzureSMProfile>]
     [<CommonParameters>]

Description

The Start-AzureSiteRecoveryTestFailoverJob cmdlet starts test failover of an Azure Site Recovery protection entity or recovery plan. You can check whether the job succeeded by using the Get-AzureRMSiteRecoveryJob cmdlet.

Examples

Example 1: Start a test failover

PS C:\> $ProtectionContainer = Get-AzureSiteRecoveryProtectionContainer
PS C:\> $ProtectionEntity = Get-AzureSiteRecoveryProtectionEntity -ProtectionContainer $ProtectionContainer
PS C:\> Start-AzureSiteRecoveryTestFailoverJob -ProtectionEntity $ProtectionEntity -Direction "PrimaryToRecovery"
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           : {}

The first command uses the Get-AzureSiteRecoveryProtectionContainer cmdlet to get a protected container, and then stores it in the $ProtectionContainer variable.

The second command gets the protected entities that belong to the protected container stored in $ProtectionContainer by using the Get-AzureSiteRecoveryProtectionEntity cmdlet. The command stores the results in the $ProtectionEntity variable.

The final command starts the test failover operation for the protected entities stored in $ProtectionEntity and specifies the direction of the failover.

Example 2: Start a test failover using a recovery plan

PS C:\> $RecoveryPlan = Get-AzureSiteRecoveryRecoveryPlan -Name "RecoveryPlan01"
Start-AzureSiteRecoveryTestFailoverJob -Direction PrimaryToRecovery -RecoveryPlan $RecoveryPlan

This command gets the recovery plan named RecoveryPlan01 for the current Azure Site Recovery vault by using the Get-AzureSiteRecoveryRecoveryPlan cmdlet. The command stores the plan in the $RecoveryPlan variable.

The second command starts the test failover operation for the recovery plan stored in $RecoveryPlan and specifies the direction of the failover.

Parameters

-Direction

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

  • PrimaryToRecovery
  • RecoveryToPrimary
Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LogicalNetworkId

Specifies the ID of the logical network.

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

-Network

Specifies the network object to use for test failover. To obtain a network, use the Get-AzureSiteRecoveryNetwork cmdlet.

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

-NetworkType

Specifies the network type to use for test failover. The acceptable values for this parameter are:

  • None
  • New
  • Existing
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

-ProtectionContainerId

Specifies the ID of a protected container. This cmdlet starts the job for a protected virtual machine that belongs to the container that this cmdlet specifies.

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

-ProtectionEntity

Specifies the Site Recovery protection entity object.

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

-ProtectionEntityId

Specifies the ID of a protected virtual machine for which to start the job.

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

-RecoveryPlan

Specifies a recovery plan for which to start the job.

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

-RpId

Specifies the ID of a recovery plan for which to start the job.

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

-VmNetworkId

Specifies the ID of the virtual machine network.

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

-WaitForCompletion

Indicates that the cmdlet waits for the operation to complete before it returns control to the Windows PowerShell console.

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