Set-WssClientBackupVolumeExcludedFolder
Set-WssClientBackupVolumeExcludedFolder
Specifies folders to exclude from client backup on a computer.
Syntax
Parameter Set: ByName
Set-WssClientBackupVolumeExcludedFolder [-ComputerName] <String> [-VolumeGuid] <Guid> [[-ExcludedFolders] <ICollection<String>> ] [-Clear] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: BySid
Set-WssClientBackupVolumeExcludedFolder [-ComputerSid] <String> [-VolumeGuid] <Guid> [[-ExcludedFolders] <ICollection<String>> ] [-Clear] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-WssClientBackupVolumeExcludedFolder cmdlet specifies folders to exclude from client backup on a computer. Specify a computer by name or security identifier (SID). Specify a volume by using its GUID.
If you use the Clear parameter, the cmdlet clears the list of excluded folders, so future backups do not exclude any folders.
Parameters
-Clear
Indicates that the cmdlet clears the list of excluded folders.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the name of a computer.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-ComputerSid<String>
Specifies the SID of a computer.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ExcludedFolders<ICollection<String>>
Specifies a collection of folder paths.
Aliases |
none |
Required? |
false |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VolumeGuid<Guid>
Specifies the GUID of a volume. To obtain a GUID, use the Get-WssClientBackupVolume cmdlet.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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, -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: Exclude folders from backup for a volume
This command excludes folders for the specified volume for the computer named Workstation073. The command accepts a collection of folders to exclude from backup.
PS C:\> Set-WssClientBackupVolumeExcludedFolder -ComputerName "Workstation073" -VolumeGuid b6b093a2-1860-4172-a4a5-07ce2aebfa13 -ExcludedFolders (@("C:\Temp","C:\Downloads") -as [string[]])