Set-VBRSelectedFilesBackupOptions

In this article

    Short Description

    Modifies the backup scope settings for Veeam Agent backup jobs.

    Applies to

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

    Syntax

    Set-VBRSelectedFilesBackupOptions -Options <VBRSelectedFilesBackupOptions> [-BackupOS] [-BackupPersonalFiles] [-BackupSelectedFiles] [-SelectedFiles <string[]>] [-IncludeMask <string[]>] [-ExcludeMask <string[]>][<CommonParameters>]

    Detailed Description

    This cmdlet modifies the backup scope settings for Veeam Agent backup jobs. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Set-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

    Options

    Specifies the file-level backup scope settings that you want to modify.

    Accepts the VBRSelectedFilesBackupOptions type.

    True

    Named

    True (ByValue)

     

    BackupOS

    NOTE: This option works 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 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
    • Directories on macOS 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
    • Directories on macOS 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 the files 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

    This example shows how to modify the existing backup scope settings for a Windows computer.

    1. Run New-VBRSelectedFilesBackupOptions to specify the selected files options. Save the result to the $scope variable
    2. Run Set-VBRSelectedFilesBackupOptions with the $scope variable. Use the BackupOS parameter to back up OS data.

    $scope = New-VBRSelectedFilesBackupOptions -OSPlatform Windows -BackupPersonalFiles

    Set-VBRSelectedFilesBackupOptions -Options $scope -BackupOS

    Related Commands

    New-VBRSelectedFilesBackupOptions