Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob

Module:: Az.RecoveryServices

Starts the test failover cleanup operation for a cluster.

Syntax

Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob
     -ReplicationProtectionCluster <ASRReplicationProtectionCluster>
     [-Comment <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob cmdlet starts the test failover cleanup operation on a replication protection cluster on which a test failover has been performed. You can check whether the job succeeded by using the Get-AzRecoveryServicesAsrJob cmdlet.

Examples

Example 1

$currentJob = Start-AzRecoveryServicesAsrClusterTestFailoverCleanupJob -ReplicationProtectionCluster $protectionCluster -Comment "testing done"

Starts the test failover cleanup operation for a replication protection cluster.

Parameters

-Comment

User Comment for Test Failover Cleanup.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ReplicationProtectionCluster

Specifies the replication protection cluster.

Type:	ASRReplicationProtectionCluster
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

ASRReplicationProtectionCluster

Outputs

ASRJob

Share via