Start-AzRecoveryServicesAsrClusterTestFailoverJob

Module:

Az.RecoveryServices Module

Starts a test failover operation for a cluster.

Syntax

Default (Default)

Start-AzRecoveryServicesAsrClusterTestFailoverJob

    -ReplicationProtectionCluster <ASRReplicationProtectionCluster>
    -Direction <String>
    [-ClusterRecoveryPoint <ASRClusterRecoveryPoint>]
    [-ListNodeRecoveryPoint <System.Collections.Generic.List`1[System.String]>]
    [-LatestProcessedRecoveryPoint]
    -AzureVMNetworkId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Start-AzRecoveryServicesAsrClusterTestFailoverJob cmdlet starts test failover of an Azure Site Recovery replication protection cluster. You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet.

Examples

Example 1

$currentJob = Start-AzRecoveryServicesAsrClusterTestFailoverJob -ReplicationProtectionCluster $protectionCluster -Direction PrimaryToRecovery -AzureVMNetworkId $TestRecoveryNetwork -LatestProcessedRecoveryPoint

Starts a test failover operation for the specified cluster. If LatestProcessedRecoveryPoint is passed and no specific recovery point is provided, it will pick the lastest processed recovery points and the ASR job used to track the operation.

Example 2

$currentJob = Start-AzRecoveryServicesAsrClusterTestFailoverJob -ReplicationProtectionCluster $protectionCluster -Direction PrimaryToRecovery -AzureVMNetworkId $TestRecoveryNetwork -ClusterRecoveryPoint $clusterRecoveryPoint -ListNodeRecoveryPoint $nodeRecoveryPoints

Starts a test failover operation for the specified cluster and by passing ClusterRecoveryPoint and NodeRecoveryPoints, it will pick the specified recovery points and returns the ASR job used to track the operation.

Parameters

-AzureVMNetworkId

Specifies the Azure vm network id for recovery VM after failover.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ClusterRecoveryPoint

Specifies the recovery point for the cluster.

Parameter properties

Type:	ASRClusterRecoveryPoint
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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Direction

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

• PrimaryToRecovery
• RecoveryToPrimary

Parameter properties

Type:	String
Default value:	None
Accepted values:	PrimaryToRecovery, RecoveryToPrimary
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-LatestProcessedRecoveryPoint

Fetch the latest processed recovery points if not passed for cluster or any individual node.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	LatestProcessedRecoveryPoint

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ListNodeRecoveryPoint

Specifies the recovery points for the nodes which are not part of cluster recovery point.

Parameter properties

Type:	List<T>[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

-ReplicationProtectionCluster

Specifies the replication protection cluster.

Parameter properties

Type:	ASRReplicationProtectionCluster
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

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.

Inputs

ASRReplicationProtectionCluster

Outputs

ASRJob