Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob

Reference

Module:: AzureRM.RecoveryServices.SiteRecovery

Starts the test failover cleanup operation.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob
     -ReplicationProtectedItem <ASRReplicationProtectedItem>
     [-Comment <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob
     -ResourceId <String>
     [-Comment <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob
     -RecoveryPlan <ASRRecoveryPlan>
     [-Comment <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob cmdlet starts the test failover cleanup operation on a replication protected item or recovery plan on which a test failover has been performed.

Examples

Example 1

PS C:\> Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob -ReplicationProtectedItem $rpi -Comments "testing done"

Job to track test failover Cleanup of an Azure Site Recovery replication protected item.

Example 2

PS C:\> Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob -RecoveryPlan $recoveryPlan -Comment "testing done"

Job to track test failover Cleanup of an Azure Site Recovery recoveryPlan.

Parameters

-Comment

User Comment for Test Failover.

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:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RecoveryPlan

Recovery Plan to perform the test failover cleanup on.

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

-ReplicationProtectedItem

Replication Protected Item to perform the test failover cleanup on.

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

-ResourceId

Resource Id of replication protected item / recovery plan for cleaningup test failover.

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

ASRRecoveryPlan

Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem

Outputs

ASRJob