< Back
Remove-DbaBackup
Post
NAME Remove-DbaBackup
SYNOPSIS
Removes SQL Server backups from disk.
SYNTAX
Remove-DbaBackup [-Path] <String> [-BackupFileExtension] <String> [-RetentionPeriod] <String> [-CheckArchiveBit
<Switch>] [-RemoveEmptyBackupFolder <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Removes SQL Server backups from disk.
Provides all of the same functionality for removing SQL backups from disk as a standard maintenance plan would.
As an addition you have the ability to check the Archive bit on files before deletion. This will allow you to
ensure backups have been archived to your archive location before removal.
Also included is the ability to remove empty folders as part of this cleanup activity.
PARAMETERS
-BackupFileExtension [<String>]
Specifies the filename extension of the backup files you wish to remove (typically 'bak', 'trn' or 'log'). Do
not include the period.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-CheckArchiveBit [<Switch>]
If this switch is enabled, the filesystem Archive bit is checked before deletion. If this bit is set (which
translates to "it has not been backed up to another location yet", the file won't be deleted.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
Specifies the name of the base level folder to search for backup files. Deletion of backup files will be
recursive from this location.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-RemoveEmptyBackupFolder [<Switch>]
If this switch is enabled, empty folders will be removed after the cleanup process is complete.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-RetentionPeriod [<String>]
Specifies the retention period for backup files. Correct format is ##U.
## is the retention value and must be an integer value
U signifies the units where the valid units are:
h = hours
d = days
w = weeks
m = months
Formatting Examples:
'48h' = 48 hours
'7d' = 7 days
'4w' = 4 weeks
'1m' = 1 month
Required? false
Position? named
Default value
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Storage, DisasterRecovery, Backup
Author: Chris Sommer (@cjsommer), www.cjsommer.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-DbaBackup -Path 'C:\\MSSQL\\SQL Backup\\' -BackupFileExtension trn -RetentionPeriod 48h
'*.trn' files in 'C:\\MSSQL\\SQL Backup\\' and all subdirectories that are more than 48 hours old will be removed.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Remove-DbaBackup -Path 'C:\\MSSQL\\SQL Backup\\' -BackupFileExtension trn -RetentionPeriod 48h -WhatIf
Same as example #1, but doesn't actually remove any files. The function will instead show you what would be done.
This is useful when first experimenting with using the function.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Remove-DbaBackup -Path 'C:\\MSSQL\\Backup\\' -BackupFileExtension bak -RetentionPeriod 7d -CheckArchiveBit
'*.bak' files in 'C:\\MSSQL\\Backup\\' and all subdirectories that are more than 7 days old will be removed, but only
if the files have been backed up to another location as verified by checking the Archive bit.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Remove-DbaBackup -Path 'C:\\MSSQL\\Backup\\' -BackupFileExtension bak -RetentionPeriod 1w
-RemoveEmptyBackupFolder
'*.bak' files in 'C:\\MSSQL\\Backup\\' and all subdirectories that are more than 1 week old will be removed. Any
folders left empty will be removed as well.
RELATED LINKS
https://dbatools.io/Remove-DbaBackup
SYNOPSIS
Removes SQL Server backups from disk.
SYNTAX
Remove-DbaBackup [-Path] <String> [-BackupFileExtension] <String> [-RetentionPeriod] <String> [-CheckArchiveBit
<Switch>] [-RemoveEmptyBackupFolder <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Removes SQL Server backups from disk.
Provides all of the same functionality for removing SQL backups from disk as a standard maintenance plan would.
As an addition you have the ability to check the Archive bit on files before deletion. This will allow you to
ensure backups have been archived to your archive location before removal.
Also included is the ability to remove empty folders as part of this cleanup activity.
PARAMETERS
-BackupFileExtension [<String>]
Specifies the filename extension of the backup files you wish to remove (typically 'bak', 'trn' or 'log'). Do
not include the period.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-CheckArchiveBit [<Switch>]
If this switch is enabled, the filesystem Archive bit is checked before deletion. If this bit is set (which
translates to "it has not been backed up to another location yet", the file won't be deleted.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables
advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own
try/catch.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Path [<String>]
Specifies the name of the base level folder to search for backup files. Deletion of backup files will be
recursive from this location.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-RemoveEmptyBackupFolder [<Switch>]
If this switch is enabled, empty folders will be removed after the cleanup process is complete.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-RetentionPeriod [<String>]
Specifies the retention period for backup files. Correct format is ##U.
## is the retention value and must be an integer value
U signifies the units where the valid units are:
h = hours
d = days
w = weeks
m = months
Formatting Examples:
'48h' = 48 hours
'7d' = 7 days
'4w' = 4 weeks
'1m' = 1 month
Required? false
Position? named
Default value
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Storage, DisasterRecovery, Backup
Author: Chris Sommer (@cjsommer), www.cjsommer.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-DbaBackup -Path 'C:\\MSSQL\\SQL Backup\\' -BackupFileExtension trn -RetentionPeriod 48h
'*.trn' files in 'C:\\MSSQL\\SQL Backup\\' and all subdirectories that are more than 48 hours old will be removed.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Remove-DbaBackup -Path 'C:\\MSSQL\\SQL Backup\\' -BackupFileExtension trn -RetentionPeriod 48h -WhatIf
Same as example #1, but doesn't actually remove any files. The function will instead show you what would be done.
This is useful when first experimenting with using the function.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Remove-DbaBackup -Path 'C:\\MSSQL\\Backup\\' -BackupFileExtension bak -RetentionPeriod 7d -CheckArchiveBit
'*.bak' files in 'C:\\MSSQL\\Backup\\' and all subdirectories that are more than 7 days old will be removed, but only
if the files have been backed up to another location as verified by checking the Archive bit.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Remove-DbaBackup -Path 'C:\\MSSQL\\Backup\\' -BackupFileExtension bak -RetentionPeriod 1w
-RemoveEmptyBackupFolder
'*.bak' files in 'C:\\MSSQL\\Backup\\' and all subdirectories that are more than 1 week old will be removed. Any
folders left empty will be removed as well.
RELATED LINKS
https://dbatools.io/Remove-DbaBackup