Edit

Set-WssClientBackupVolumeExcludedFolder

  • Reference
Module:
WSSCmdlets

Specifies folders to exclude from client backup on a computer.

Syntax

Set-WssClientBackupVolumeExcludedFolder
   [[-ExcludedFolders] <System.Collections.Generic.ICollection`1[System.String]>]
   [-Clear]
   [-VolumeGuid] <Guid>
   [-ComputerName] <String>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-WssClientBackupVolumeExcludedFolder
   [[-ExcludedFolders] <System.Collections.Generic.ICollection`1[System.String]>]
   [-Clear]
   [-VolumeGuid] <Guid>
   [-ComputerSid] <String>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

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.

Examples

Example 1: Exclude folders from backup for a volume

PS C:\> Set-WssClientBackupVolumeExcludedFolder -ComputerName "Workstation073" -VolumeGuid b6b093a2-1860-4172-a4a5-07ce2aebfa13 -ExcludedFolders (@("Temp\","Downloads\") -as [string[]])

This command excludes folders for the specified volume for the computer named Workstation073. The command accepts a collection of folders to exclude from backup.

Parameters

-Clear

Indicates that the cmdlet clears the list of excluded folders.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies the name of a computer.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ComputerSid

Specifies the SID of a computer.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExcludedFolders

Specifies a collection of folder paths. The volume containing the folders is specified by the -VolumeGuid parameter, so do not include the volume letter as part of the path.

Type:ICollection<T>[String]
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VolumeGuid

Specifies the GUID of a volume. To obtain a GUID, use the Get-WssClientBackupVolume cmdlet.

Type:Guid
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False