Start-AzureSiteRecoveryCommitFailoverJob
Starts the commit failover action for a Site Recovery object.
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
ByRPId (Default)
Start-AzureSiteRecoveryCommitFailoverJob
-RPId <String>
[-Direction <String>]
[-WaitForCompletion]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByPEId
Start-AzureSiteRecoveryCommitFailoverJob
-ProtectionEntityId <String>
-ProtectionContainerId <String>
[-Direction <String>]
[-WaitForCompletion]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByRPObject
Start-AzureSiteRecoveryCommitFailoverJob
-RecoveryPlan <ASRRecoveryPlan>
[-Direction <String>]
[-WaitForCompletion]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByPEObject
Start-AzureSiteRecoveryCommitFailoverJob
-ProtectionEntity <ASRProtectionEntity>
[-Direction <String>]
[-WaitForCompletion]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
The Start-AzureSiteRecoveryCommitFailoverJob cmdlet starts the commit failover process for an Azure Site Recovery object after a failover operation.
Examples
Example 1: Start a commit failover job
PS C:\> $Container = Get-AzureSiteRecoveryProtectionContainer
PS C:\> $Protected = Get-AzureSiteRecoveryProtectionEntity -ProtectionContainer $Container
PS C:\> Start-AzureSiteRecoveryCommitFailoverJob -ProtectionEntity $Protected
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 gets all protected containers for the current Azure Site Recovery vault by using the Get-AzureSiteRecoveryProtectionContainer cmdlet, and then stores the results in the $Container variable.
The second command gets the protected virtual machines that belong to the container stored in $Container by using the Get-AzureSiteRecoveryProtectionEntity cmdlet. The command stores the results in the $Protected variable.
The final command starts the failover job for the protected objects stored in $Protected.
Parameters
-Direction
Specifies the direction of the failover. The acceptable values for this parameter are:
- PrimaryToRecovery
- RecoveryToPrimary
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByPEId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProtectionEntity
Specifies an ASRProtectionEntity object for which to start the job. To obtain an ASRProtectionEntity object, use the Get-AzureSiteRecoveryProtectionEntity cmdlet.
Parameter properties
| Type: | ASRProtectionEntity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByPEObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProtectionEntityId
Specifies the ID of a protected virtual machine for which to start the job.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByPEId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RecoveryPlan
Specifies a recovery plan object for which to start the job. To obtain an ASRRecoveryPlan object, use the Get-AzureSiteRecoveryRecoveryPlan cmdlet.
Parameter properties
| Type: | ASRRecoveryPlan |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByRPObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RPId
Specifies the ID of a recovery plan for which to start the job.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByRPId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WaitForCompletion
Indicates that the cmdlet waits for the operation to complete before it returns control to the Windows PowerShell console.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.