Set-VBRNASBackupJobObject

Short Description

Modifies settings of files and folders that will be added to the file backup job.

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

Syntax

Set-VBRNASBackupJobObject -JobObject <VBRNASBackupObject> [-InclusionMask <VBRNASBackupMask[]>]

[-ExclusionMask <VBRNASBackupMask[]>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of files and folders that will be added to the file backup job.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ExclusionMask	Specifies a file mask for folders and files that you do not want to add to the file backup job. The cmdlet will not back up these folders and files.	`VBRNASBackupMask[]`	False	Named	False
InclusionMask	Specifies a file mask for folders and files that you want to add to the file backup job. The cmdlet will back up only folders and files specified in this file mask.	`VBRNASBackupMask[]`	False	Named	False
JobObject	Specifies the settings of files and folders that will be added to the file backup job. The cmdlet will modify these settings. Accepts the `VBRNASBackupJobObject` object. To create this object, run the `New-VBRNASBackupJobObject` cmdlet.	`VBRNASBackupObject`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRNASBackupJobObject object that contains settings of files and folders that will be added to the file backup job.

Examples

Set-VBRNASBackupJobObject Example 1. Modifying Included Files

This example shows how to modify settings of a file mask for files that you want to add to the file backup job. The job will back up only .DOCX and .PDF files that are located in the \\WinSRV2049\Documents\January folder.

$server = Get-VBRUnstructuredServer -Name "\\WinSRV2049\Documents"

$files = New-VBRNASBackupJobObject -Server $server -Path "\\WinSRV2049\Documents\January" -InclusionMask "*.docx"

$modifiedFiles = Set-VBRNASBackupJobObject -JobObject $files -InclusionMask ("*.docx", "*.pdf")

Perform the following steps:

Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the New-VBRNASBackupJobObject cmdlet. Specify the following settings:
- Set the $server variable as the Server parameter value.
- Specify the Path parameter value.
- Specify the InclusionMask parameter value.
- Save the result to the $files variable.
Run the Set-VBRNASBackupJobObject cmdlet. Set the $files as the JobObject parameter. Specify the InclusionMask parameter value. Save the result to the $modifiedFiles variable to be used with other cmdlets.

Set-VBRNASBackupJobObject Example 2. Modifying Excluded Files

This example shows how to modify settings of file mask for files that you want to exclude from the file backup job. The job will not back up .EXE files that are located in the \\WinSRV2049\Documents\January folder.

$server = Get-VBRUnstructuredServer -Name "\\WinSRV2049\Documents"

$files = New-VBRNASBackupJobObject -Server $server -Path "\\WinSRV2049\Documents\January" -ExclusionMask "*.exe"

$modifiedFiles = Set-VBRNASBackupJobObject -JobObject $files -ExclusionMask "*.exe"

Perform the following steps:

Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the New-VBRNASBackupJobObject cmdlet. Specify the following settings:
- Set the $server variable as the Server parameter value.
- Specify the Path parameter value.
- Specify the ExclusionMask parameter value.
- Save the result to the $files variable.
Run the Set-VBRNASBackupJobObject cmdlet. Set the $files as the JobObject parameter. Specify the ExclusionMask parameter value. Save the result to the $modifiedFiles variable to be used with other cmdlets.