Remove-WssBackupConfiguration
Remove-WssBackupConfiguration
Removes a file specification from a backup volume.
Syntax
Parameter Set: Default
Remove-WssBackupConfiguration [-Volume] <BackupVolume> [-Configuration] <BackupFileSpec> [ <CommonParameters>]
Detailed Description
The Remove-WssBackupConfiguration cmdlet removes a file specification from a backup volume. When you remove a file specification from a backup volume, the files and folders in the file specification are no longer backed up with the backup volume.
Parameters
-Configuration<BackupFileSpec>
Specifies the backup file specification to remove from the volume.
Aliases |
Config |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Volume<BackupVolume>
Specifies the volume from which to remove the file specification.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Remove a file specification from a backup volume
This command removes the backup file specification from a backup volume.
The first command gets the backup volumes from the server and stores them in the variable named $ContosoBUVolume110.
The second command gets the backup file specification from the first item (located in position 0) in $ContosoBUVolume110 and stores the backup file specification in the variable named $ContosoBUFilespec05.
The third command removes the backup file specification from the second item (located in position 1) in $ContosoBUFilespec05.
PS C:\> $ContosoBUVolume110 = Get-WssBackupVolume -AllVolumes
PS C:\> $ContosoBUFilespec05 = Get-WssBackupConfiguration –Volume $ContosoBUVolume110[0]
PS C:\> Remove-WssBackupConfiguration -Configuration $ContosoBUFilespec05[1]