Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

New-VBRSelectedFilesBackupOptions

Short Description

Creates backup scope settings for Veeam Agent backup jobs.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

New-VBRSelectedFilesBackupOptions -OSPlatform <VBRAgentType> {Windows | Linux} [-BackupOS] [-BackupPersonalFiles] [-BackupSelectedFiles]
[-SelectedFiles <string[]>] [-IncludeMask <string[]>] [-ExcludeMask <string[]>][<CommonParameters>]

Detailed Description

This cmdlet creates a VBRSelectedFilesBackupOptions object that contains the backup scope settings. The backup scope includes individual folders and volumes that you want to back up.

For Veeam Agent jobs applied to Windows computers the backup scope may include:

  • OS related data
  • User profile folder with all settings and data
  • Volumes or individual folders

For Veeam Agent jobs applied to Linux computers, the scope may include volumes or individual directories only.

New-VBRSelectedFilesBackupOptions Tip:

For Windows machines you can use system environment variables to specify the backup scope and the exclude mask settings.

You must type the backslash before the environment variable. For example: \%TEMP%, \%ProgramFiles% or \%WinDir%.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

OSPlatform

Specifies the OS of the protected computers:

  • Windows: for Windows computers
  • Linux: for Linux computers

True

Named

False

 

BackupOS

NOTE: This option works only for Veeam Agent jobs that back up Windows computers.

Indicates that Veeam Backup & Replication will include the OS related data into the backup scope.

With this option enabled Veeam Backup & Replication will include personal files into the backup scope by default.

False

Named

False

 

BackupPersonalFiles

NOTE: This option works only for Veeam Agent jobs that back up Windows computers.

Indicates that Veeam Backup & Replication will include the user profile folders into the backup scope.

False

Named

False

 

BackupSelectedFiles

Indicates that Veeam Backup & Replication will include the following types of folders into the backup scope:

  • Volumes
  • Individual folders on Windows computers
  • Directories on Linux computers

Use the SelectedFiles parameter to specify the backup scope.

False

Named

False

 

SelectedFiles

For the BackupSelectedFiles parameter.

Specifies the backup scope settings. To back up the folders, you must specify either of the following settings:

  • Volume name
  • The path to the individual folder on Windows computers
  • The path to the directory on Linux computers

False

Named

False

 

IncludeMask

Specifies the file names and/or masks for file types that you want to include into the backup scope.

False

Named

False

 

ExcludeMask

Specifies files and directories that you want to exclude from the backup scope. You can specify the following types of files:

  • File names
  • File masks for file types

False

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

Example 1

This command creates the backup scope settings for the Veeam Agent job that backs up a Windows computer. The backup scope will include the user profile folders and settings.

PS C:\PS> New-VBRSelectedFilesBackupOptions -OSPlatform Windows -BackupPersonalFiles

Example 2

This command creates the backup scope settings for the Veeam Agent job that backs up a Linux computer. The backup scope will include the files from the /home/administrator/mydir directory.

PS C:\PS> New-VBRSelectedFilesBackupOptions -OSPlatform Linux -BackupSelectedFiles -SelectedFiles "/home/administrator/mydir"

Example 3

This command creates the backup scope settings for the Veeam Agent job that backs up a Windows computer. The backup scope will include OS related files and will exclude the temporary folder from the backup.

PS C:\Users\Administrator> $options = New-VBRSelectedFilesBackupOptions -OSPlatform Windows -BackupOS -ExcludeMask "\%Temp%"

Example 4

This command creates the backup scope settings for the Veeam Agent job that backs up a Linux computer. The backup scope will include the files from the /home/user01/ directory and will exclude all files of the PDF format.

PS C:\PS> New-VBRSelectedFilesBackupOptions -OSPlatform Linux -BackupSelectedFiles -SelectedFiles "/home/user01/" -ExcludeMask *pdf*

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation