Skip to main content
SnapCenter 4.9 cmdlets

Remove-SmBackup

Contributors

Removes one or more backup.

Syntax

Remove-SmBackup [-BackupNames]  <String>  [-BackupIds]  <String>  [-DeleteSecondaryMetadata]  <>  [-CleanupSecondaryBackups]  <>  [-SourceVolumes]  <String>  [-CleanupBackups]  <>  [-Force]  <>  [-Auth]  <String>  [-AppObjectId]  <String>

Detailed Description

Removes one or more backup.

Parameters

Name Description Required? Pipeline Input Default Value

BackupNames

Specifies the list of backup names to be deleted.

false

true (ByPropertyName)

BackupIds

Specifies the list of backup ids to be deleted.

false

true (ByPropertyName)

DeleteSecondaryMetadata

Specifies that the secondary backup metadata should be deleted.

false

true (ByPropertyName)

CleanupSecondaryBackups

Specifies that the secondary backups that have no secondary Snapshot copies are cleaned up.

false

true (ByPropertyName)

SourceVolumes

Specifies the source volumes whose secondary volumes are deleted. Use this option to clean-up the secondary backup metadata for the deleted volumes.

false

true (ByPropertyName)

CleanupBackups

This cmdlet cleans up the backups that do not have Snapshot copies.

false

true (ByPropertyName)

Force

Forces the removal of a backup.

false

true (ByPropertyName)

Auth

false

true (ByPropertyName)

AppObjectId

false

true (ByPropertyName)

Examples

Example 1: Removing multiple backups using the backup ID

 Remove-SmBackup -BackupIds 3,4

This example syntax removes multiple backups using the backup IDs.

Remove-SmBackup
Are you sure want to remove the backup(s).
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):

Example 2: Removing multiple backups using the backup name

 Remove-SmBackup -BackupNames "Payroll Dataset_vise-f6_08-04-2015_12.01.56.2744","Payroll Dataset_vise f6_08-04-2015_12.02.27.8732"
Remove-SmBackup
Are you sure want to remove the backup(s).
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"):
BackupResult : {}
Result   : SMCoreContracts.SMResult
TotalCount   : 0
DisplayCount : 0
Context  :
Job  : SMCoreContracts.SmJob

Example 3: Removing secondary backup metadata

 Remove-SmBackup -BackupIds 1 -DeleteSecondaryMetadata

This example syntax removes secondary backup metadata.

Remove-SmBackup
Are you sure want to remove the backup(s).
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (default is "Y"):
BackupResult : {}
Result   : SMCoreContracts.SMResult
TotalCount   : 0
DisplayCount : 0
Context  :
Job  : SMCoreContracts.SmJob

Example 4: Cleaning up secondary backups without a confirm dialogue

 Remove-SmBackup -CleanupSecondaryBackups -Confirm:$false

This example syntax cleans up secondary backups that do not have secondary Snapshot copies.

BackupResult : {}
Result   : SMCoreContracts.SMResult
TotalCount   : 0
DisplayCount : 0
Context  :
Job  : SMCoreContracts.SmJob

Example 5: Cleaning up secondary backups where secondary volume is deleted

 Remove-SmBackup -CleanupSecondaryBackups -SourceVolumes SVM1:Volume1,SVM2:Volume2

This example syntax cleans up the secondary backups that do not have any secondary snapshot copies or the secondary volumes are deleted for the specified source volumes.

BackupResult : {}
Result   : SMCoreContracts.SMResult
TotalCount   : 0
DisplayCount : 0
Context  :
Job  : SMCoreContracts.SmJob