< Back

Start-AzureRmRecoveryServicesAsrTestFailoverJob

Tue Jan 29, 2019 10:02 pm

NAME Start-AzureRmRecoveryServicesAsrTestFailoverJob



SYNOPSIS

Starts a test failover operation.





SYNTAX

Start-AzureRmRecoveryServicesAsrTestFailoverJob -AzureVMNetworkId <String> [-CloudServiceCreationOption {UseRecoveryCloudService |

AutoCreateCloudService}] [-Confirm] [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile

<IAzureContextContainer>] -Direction {PrimaryToRecovery | RecoveryToPrimary} -RecoveryPlan <ASRRecoveryPlan> [-RecoveryTag {Latest |

LatestAvailable | LatestAvailableApplicationConsistent}] [-WhatIf] [<CommonParameters>]



Start-AzureRmRecoveryServicesAsrTestFailoverJob -AzureVMNetworkId <String> [-CloudServiceCreationOption {UseRecoveryCloudService |

AutoCreateCloudService}] [-Confirm] [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile

<IAzureContextContainer>] -Direction {PrimaryToRecovery | RecoveryToPrimary} [-RecoveryPoint <ASRRecoveryPoint>] -ReplicationProtectedItem

<ASRReplicationProtectedItem> [-WhatIf] [<CommonParameters>]



Start-AzureRmRecoveryServicesAsrTestFailoverJob [-CloudServiceCreationOption {UseRecoveryCloudService | AutoCreateCloudService}] [-Confirm]

[-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] -Direction

{PrimaryToRecovery | RecoveryToPrimary} [-RecoveryPoint <ASRRecoveryPoint>] -ReplicationProtectedItem <ASRReplicationProtectedItem> [-WhatIf]

[<CommonParameters>]



Start-AzureRmRecoveryServicesAsrTestFailoverJob [-CloudServiceCreationOption {UseRecoveryCloudService | AutoCreateCloudService}] [-Confirm]

[-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>] [-DefaultProfile <IAzureContextContainer>] -Direction

{PrimaryToRecovery | RecoveryToPrimary} -RecoveryPlan <ASRRecoveryPlan> [-RecoveryTag {Latest | LatestAvailable |

LatestAvailableApplicationConsistent}] [-WhatIf] [<CommonParameters>]



Start-AzureRmRecoveryServicesAsrTestFailoverJob [-Confirm] [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>]

[-DefaultProfile <IAzureContextContainer>] -Direction {PrimaryToRecovery | RecoveryToPrimary} -RecoveryPlan <ASRRecoveryPlan> [-RecoveryTag

{Latest | LatestAvailable | LatestAvailableApplicationConsistent}] -VMNetwork <ASRNetwork> [-WhatIf] [<CommonParameters>]



Start-AzureRmRecoveryServicesAsrTestFailoverJob [-Confirm] [-DataEncryptionPrimaryCertFile <String>] [-DataEncryptionSecondaryCertFile <String>]

[-DefaultProfile <IAzureContextContainer>] -Direction {PrimaryToRecovery | RecoveryToPrimary} [-RecoveryPoint <ASRRecoveryPoint>]

-ReplicationProtectedItem <ASRReplicationProtectedItem> -VMNetwork <ASRNetwork> [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Start-AzureRmRecoveryServicesAsrTestFailoverJob cmdlet starts test failover of an Azure Site Recovery replication protected item or recovery

plan. You can check whether the job succeeded by using the Get-AzureRmRecoveryServicesAsrJob cmdlet.





PARAMETERS

-AzureVMNetworkId <String>

Specifies the Azure virtual network ID to connect the test fail over virtual machine(s) to.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-CloudServiceCreationOption <String>

Specifies whether a new cloud service should be created or the recovery cloud service configured for the VM should be used for the test

failover.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

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 failover direction. The acceptable values for this parameter are:



- PrimaryToRecovery



- RecoveryToPrimary



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-RecoveryPlan <ASRRecoveryPlan>

Specifies an ASR recovery plan object.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-RecoveryPoint <ASRRecoveryPoint>

Specifies a custom recovery point to test failover the protected machine to.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-RecoveryTag <String>

Specifies the recovery tag to test failover to



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ReplicationProtectedItem <ASRReplicationProtectedItem>

Specifies an ASR replication protected item.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-VMNetwork <ASRNetwork>

Specifies the Site Recovery virtual machine network to connect the test failover virtual machine(s) to.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

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

Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan

Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem





OUTPUTS

Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRJob







NOTES









Example 1



PS C:\\> $currentJob = Start-AzureRmRecoveryServicesAsrTestFailoverJob -RecoveryPlan $RP -Direction PrimaryToRecovery -VMNetwork

$TestRecoveryNetwork



Starts the test failover operation for the recovery plan with the specified parameters and returns the ASR job used to track the operation.







RELATED LINKS

Online Version:

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

Get-AzureRmRecoveryServicesAsrJob