New-VBRSelectedPersonalFolders

Short Description

Defines 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

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

Detailed Description

This cmdlet creates the VBRSelectedPersonalFolders object that specifies the scope of personal data for Agent Backup jobs that back up Microsoft Windows machines. You can use this object in the following cmdlets:

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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 Microsoft Docs.

Output Object

VBRSelectedPersonalFolders

Examples

New-VBRSelectedPersonalFoldersExample 1. Including Desktop Folder in Backup Scope

This command includes to the backup scope data stored in the Desktop folder on the system volume. Save the result to the $folders variable.

$folders = New-VBRSelectedPersonalFolders -Desktop

New-VBRSelectedPersonalFoldersExample 2. Including Pictures Folder in Backup Scope

This command includes to the backup scope data stored in the Pictures folder on the system volume. Save the result to the $folders variable.

$folders = New-VBRSelectedPersonalFolders -Pictures

New-VBRSelectedPersonalFoldersExample 3. Excluding Roaming User Profiles from Backup Scope

This command excludes roaming user profiles from the backup scope. Save the result to the $folders variable.

$folders = New-VBRSelectedPersonalFolders -ExcludeRoamingUsers