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

Start-AzureSiteRecoveryUnplannedFailoverJob

microsoft.azure.commands.recoveryservices.dll

Synopsis

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

Syntax

Start-AzureSiteRecoveryUnplannedFailoverJob [-Direction] [-ProtectionContainerId] [-ProtectionEntityId] [-PerformSourceSideActions] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryUnplannedFailoverJob [-Direction] [-ProtectionEntity] [-PerformSourceSideActions] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryUnplannedFailoverJob [-Direction] [-RpId] [-PerformSourceSideActions] [-WaitForCompletion] [<CommonParameters>]

Start-AzureSiteRecoveryUnplannedFailoverJob [-Direction] [-RecoveryPlan] [-PerformSourceSideActions] [-WaitForCompletion] [<CommonParameters>]

Detailed Description

Start the Unplanned Failover operation for a Protection Entity or Recovery Plan under Azure Site Recovery. This will start the failover job and success of 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

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

Recovery Plan object

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-RpId <string>

Id of the Recovery Plan

Aliases

None

Required?

true

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

-ProtectionEntityId <string>

Id of the Protection Entity

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ProtectionContainerId <string>

Id of the Protection Container

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PerformSourceSideActions <SwitchParameter>

Its used for indicating whether can do source site operations.

Aliases

None

Required?

false

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-AzureSiteRecoveryUnplannedFailoverJob -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           : {}