< Back

Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob

Tue Jan 29, 2019 10:03 pm

NAME Start-AzureRmRecoveryServicesAsrTestFailoverCleanupJob



SYNOPSIS

Starts the test failover cleanup operation.





SYNTAX

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

<ASRRecoveryPlan> [-WhatIf] [<CommonParameters>]



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

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



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

<String> [-WhatIf] [<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.





PARAMETERS

-Comment <String>

User Comment for 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



-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



-RecoveryPlan <ASRRecoveryPlan>

Recovery Plan to perform the test failover cleanup on.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-ReplicationProtectedItem <ASRReplicationProtectedItem>

Replication Protected Item to perform the test failover cleanup on.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-ResourceId <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

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:\\> 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 -ReplicationProtectedItem $recoveryPlan -Comments "testing done"



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







RELATED LINKS

Online Version:

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