Set-VBRSelectedPersonalFolders

In this article

    Short Description

    Modifies the scope of personal data for Agent Backup jobs that back up Microsoft Windows machines.

    Applies to

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Set-VBRSelectedPersonalFolders -SelectedPersonalFolders <VBRSelectedPersonalFolders> [-Desktop <SwitchParameter>][-Documents <SwitchParameter>] [-Pictures <SwitchParameter>] [-Video <SwitchParameter>] [-Favorites <SwitchParameter>] [-Downloads <SwitchParameter>] [-ApplicationData <SwitchParameter>] [-Custom <SwitchParameter>][-ExcludeRoamingUsers <SwitchParameter>] [-ExcludeOneDrive <SwitchParameter>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies the scope of personal data for Agent Backup jobs that back up Microsoft Windows machines. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    SelectedPersonalFolders

    Specifies the scope of personal data that you want to modify.

    Accepts the VBRSelectedPersonalFolders object. To create this object, run the New-VBRSelectedPersonalFolders cmdlet.

    True

    Named

    True(ByValue)

    Desktop

    Defines that the cmdlet will include to the backup scope data stored in the Desktop folder on the system volume.

    SwitchParameter

    False

    Named

    False

    Documents

    Defines that the cmdlet will include to the backup scope data stored in the Documents folder on the system volume.

    SwitchParameter

    False

    Named

    False

    Pictures

    Defines that the cmdlet will include to the backup scope data stored in the Pictures folder on the system volume.

    SwitchParameter

    False

    Named

    False

    Video

    Defines that the cmdlet will include to the backup scope data stored in the Video folder on the system volume.

    SwitchParameter

    False

    Named

    False

    Favorites

    Defines that the cmdlet will include to the backup scope data stored in the Favorites folder on the system volume.

    SwitchParameter

    False

    Named

    False

    Downloads

    Defines that the cmdlet will include to the backup scope data stored in the Downloads folder on the system volume.

    SwitchParameter

    False

    Named

    False

    ApplicationData

    Defines that the cmdlet will include to the backup scope application data stored on the system volume.

    SwitchParameter

    False

    Named

    False

    Custom

    Defines that the cmdlet will include to the backup scope data stored in the in custom locations on the system volume.

    SwitchParameter

    False

    Named

    False

    ExcludeRoamingUsers

    Excludes roaming user profiles from the backup scope. If you do not provide this parameter, the cmdlet will include roaming user profiles to the backup scope.

    SwitchParameter

    False

    Named

    False

    ExcludeOneDrive

    Excludes data stored in the OneDrive folder from the backup scope. If you do not provide this parameter, the cmdlet will include data stored in the OneDrive folder to the backup scope.

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    VBRSelectedPersonalFolders

    Examples

    Modifying Scope of Personal Data for Agent Backup Jobs that Back Up Microsoft Windows Machines

    This example shows how to define the following settings for personal data scope:

    • The cmdlet will include data stored in the Favorites and Downloads folders to the backup scope.
    • The cmdlet will exclude data stored in the OneDrive folder from the backup scope.

    $folders = New-VBRSelectedPersonalFolders

    Set-VBRSelectedPersonalFolders -SelectedPersonalFolders $folders -Favorites -Downloads -ExcludeOneDrive

    Perform the following steps:

    1. Run the New-VBRSelectedPersonalFolders cmdlet. Save the result to the $folders variable.
    2. Run the Set-VBRSelectedPersonalFolders cmdlet.

    Set the $folders variable as the SelectedPersonalFolders parameter value. Specify the following settings:

    • Provide the Favorites parameter.
    • Provide the Downloads parameter.
    • Provide the ExcludeOneDrive parameter.