Start-AzureRmSiteRecoveryPlannedFailoverJob

NAME Start-AzureRmSiteRecoveryPlannedFailoverJob



SYNOPSIS

Starts a Site Recovery planned failover operation.





SYNTAX

Start-AzureRmSiteRecoveryPlannedFailoverJob [-CreateVmIfNotFound {Yes | No}] [-DataEncryptionPrimaryCertFile <String>]

[-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] -Direction {PrimaryToRecovery | RecoveryToPrimary}

[-Optimize {ForDownTime | ForSynchronization}] -ProtectionEntity <ASRProtectionEntity> [-Server <ASRServer>] [<CommonParameters>]



Start-AzureRmSiteRecoveryPlannedFailoverJob [-CreateVmIfNotFound {Yes | No}] [-DataEncryptionPrimaryCertFile <String>]

[-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] -Direction {PrimaryToRecovery | RecoveryToPrimary}

[-Optimize {ForDownTime | ForSynchronization}] -RecoveryPlan <ASRRecoveryPlan> [<CommonParameters>]



Start-AzureRmSiteRecoveryPlannedFailoverJob [-CreateVmIfNotFound {Yes | No}] [-DataEncryptionPrimaryCertFile <String>]

[-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] -Direction {PrimaryToRecovery | RecoveryToPrimary}

[-Optimize {ForDownTime | ForSynchronization}] -ReplicationProtectedItem <ASRReplicationProtectedItem> [-ServicesProvider

<ASRRecoveryServicesProvider>] [<CommonParameters>]





DESCRIPTION

The Start-AzureRmSiteRecoveryPlannedFailoverJob cmdlet starts a planned failover for an Azure Site Recovery protection entity or recovery plan.

You can check whether the job succeeds by using the Get-AzureRmSiteRecoveryJob cmdlet.





PARAMETERS

-CreateVmIfNotFound <String>

The acceptable values for this parameter are:



- Yes



- No



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DataEncryptionPrimaryCertFile <String>

Specifies the primary certificate file.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DataEncryptionSecondaryCertFile <String>

Specifies the secondary certificate file.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Direction <String>

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



- PrimaryToRecovery



- RecoveryToPrimary



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Optimize <String>

Specifies what to optimize for. This parameter applies when failover is done from an Azure site to an on-premise site which requires a

substantial data synchronization. Valid values are:



- ForDowntime



- ForSynchronization





When ForDowntime is specified, this indicates that data is synchronized before failover to minimize downtime. Synchronization is performed

without shutting down the virtual machine. After synchronization is complete, the job is suspended. Resume the job to do an additional

synchronization operation that shuts down the virtual machine.

When ForSynchronization is specified, this indicates that data is synchronized during failover only so data synchronization is minimized. With

this setting enabled, the virtual machine is shut down immediately. Synchronization starts after shutdown to complete the failover operation.





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProtectionEntity <ASRProtectionEntity>

Specifies the Site Recovery protection entity object.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-RecoveryPlan <ASRRecoveryPlan>

Specifies a recovery plan object.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-ReplicationProtectedItem <ASRReplicationProtectedItem>





Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Server <ASRServer>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ServicesProvider <ASRRecoveryServicesProvider>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



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







NOTES











RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ailoverjob