Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Start-AzureSiteRecoveryTestFailoverJob

Start-AzureSiteRecoveryTestFailoverJob

microsoft.azure.commands.recoveryservices.dll

Synopsis

The Start-AzureSiteRecoveryTestFailoverJob cmdlet starts the test failover for a protection entity or for a recovery plan in Microsoft Azure Site Recovery. Check whether the job succeeds by using the Get-AzureSiteRecoveryJob cmdlet.

Syntax

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-ProtectionContainerId] [-ProtectionEntityId] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-LogicalNetworkId] [-ProtectionContainerId] [-ProtectionEntityId] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-Network] [-NetworkType] [-ProtectionContainerId] [-ProtectionEntityId] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-ProtectionContainerId] [-ProtectionEntityId] [-VmNetworkId] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-ProtectionEntity] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-LogicalNetworkId] [-ProtectionEntity] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-Network] [-NetworkType] [-ProtectionEntity] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-ProtectionEntity] [-VmNetworkId] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-RpId] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-VmNetworkId] [-LogicalNetworkId] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-Network] [-NetworkType] [-RpId] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-VmNetworkId] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-RecoveryPlan] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-RecoveryPlan] [-LogicalNetworkId] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-Network] [-NetworkType] [-RecoveryPlan] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryTestFailoverJob [-Direction] [-RecoveryPlan] [-NetworkType] [-WaitForCompletion] [<CommonParameters>]

Detailed Description

Start the Test Failover operation for a Protection Entity or Recovery Plan under Azure Site Recovery. This will start the test failover job and success of test failover can be tracked state of the Job using Get-AzureSiteRecoveryJob

Parameters

-Direction <string>

Direction of the failover, either PrimaryToRecovery or RecoveryToPrimary

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-LogicalNetworkId <string>

Specifies the ID of the logical network.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-WaitForCompletion <SwitchParameter>

Waits till the operation completes

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RecoveryPlan <ASRRecoveryPlan>

Specifies an ASRRecoveryPlan object for which to start the job. To obtain a recovery plan object, use the Get-AzureSiteRecoveryRecoveryPlan cmdlet. This cmdlet starts a test failover for the recovery plan that this parameter specifies.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RpId <string>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ProtectionEntity <ASRProtectionEntity>

Protection Entity object

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-ProtectionContainerId <string>

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.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ProtectionEntityId <string>

Specifies an ASRProtectionEntity object for which to start the job. To obtain a protection entity object, use the Get-AzureSiteRecoveryProtectionEntity cmdlet. This cmdlet starts a test failover for the protected entity that this parameter specifies.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-VmNetworkId <string>

Specifies the ID of the virtual machine network.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NetworkType <string>

Specifies the network type to be used for test failover.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Network <ASRNetwork>

Specifies the network object to be used for test failover.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>

Description

-----------

          $PC = Get-AzureSiteRecoveryProtectionContainer; $PE = Get-AzureSiteRecoveryProtectionEntity -ProtectionContainer $PC; Start-AzureSiteRecoveryTestFailoverJob -ProtectionEntity $PE -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           : {}
        

-------------------------- EXAMPLE 2 --------------------------

C:\PS>

Description

-----------

          $RP = Get-AzureSiteRecoveryRecoveryPlan -Name "RP1"
          Start-AzureSiteRecoveryTestFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery

          Name             :
          ID               : 4a991243-a97f-4617-97be-a6e0dc99a2ff
          ClientRequestId  : 0ae1226f-b68d-4131-b2e8-17bb4c19fa29-2015-02-17 14:35:46Z-P
          State            : NotStarted
          StateDescription : NotStarted
          StartTime        :
          EndTime          :
          TargetObjectId   :
          TargetObjectType :
          TargetObjectName :
          AllowedActions   :
          Tasks            : {}
          Errors           : {}