Import-VBRJobObjectMasks

Short Description

Returns details on the masks for file backup jobs and object storage backup jobs.

Applies to

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

Syntax

Import-VBRJobObjectMasks -Path <String> -Job <CBackupJob> [<CommonParameters>]

Detailed Description

This cmdlet returns details on inclusion and exclusion masks for file backup jobs and object storage backup jobs.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Path	Specifies a path to a folder where the masks are located. The cmdlet will export masks to this folder.	String	True	Named	True (ByPropertyName, ByValue)
Job	Specifies an array of file backups job and object storage backup job. The cmdlet will return details on the a scope of objects for these jobs.	Accepts the CBackupJob object. To get this object, run the Get-VBRUnstructuredBackupJob cmdlet.	True	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Path

Specifies a path to a folder where the masks are located. The cmdlet will export masks to this folder.

String

True

Named

True (ByPropertyName, ByValue)

Job

Specifies an array of file backups job and object storage backup job. The cmdlet will return details on the a scope of objects for these jobs.

Accepts the CBackupJob object. To get this object, run the Get-VBRUnstructuredBackupJob cmdlet.

True

Named

False

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

Output Object

VBRImportedUnstructuredBackupMasks

Examples

Import-VBRJobObjectMasks Example 1. Getting Masks for Object Storage Backup Job

This example shows how to get details on inclusion and exclusion masks for the Azure object storage backup jobs.

$OSjob = Get-VBRUnstructuredBackupJob -Name "Azure backup"

Import-VBRJobObjectMasks -Path "C:\excludes2.txt" -Job $OSjob

Perform the following steps:

Run the Get-VBRUnstructuredBackupJob cmdlet. Specify the Name parameter value. Save the result to the $OSjob variable.
Run the Import-VBRJobObjectMasks cmdlet. Specify the Path parameter value. Set the $OSjob variable as the Job parameter value.

Import-VBRJobObjectMasks Example 2. Setting Masks for Object Storage Backup Jobs

This example shows how to set the inclusion and exclusion masks for the Azure object storage backup jobs.

$Job = Get-VBRUnstructuredBackupJob -Name 'fjmasks'

$BackupObjects = $Job.BackupObject

$exclusionMask = (Import-VBRJobObjectMasks -Path "C:\export.xml").excludemasks

$inclusionMask = (Import-VBRJobObjectMasks -Path "C:\export.xml").includemasks

$FilteredObject = Set-VBRObjectStorageBackupJob -JobObject $BackupObjects[0] -ExclusionMask $exclusionMask -InclusionMask $inclusionMask

Set-VBRObjectStorageBackupJob -Job $Job -BackupObject $FilteredObject

Perform the following steps:

Run the Get-VBRUnstructuredBackupJob cmdlet. Specify the Name parameter value. Save the result to the $Job variable.
Specify the BackupObject property of the $Job variable value. Save result to the $Job variable.
Get the exclude mask. Declare the $exclusionMask variable. Run the Import-VBRJobObjectMasks cmdlet. Provide the Path parameter. Get the excludemasks property of the VBRImportedUnstructuredBackupMasks object. Save result to the $exclusionMask variable.
Get the include mask. Declare the $inclusionMask variable. Run the Import-VBRJobObjectMasks cmdlet. Provide the Path parameter. Get the includemasks property of the VBRImportedUnstructuredBackupMasks object. Save result to the $inclusionMask variable.
Run the Set-VBRObjectStorageBackupJob cmdlet. Specify the JobObject, ExclusionMask, InclusionMask parameters values. Save the result to the $FilteredObject variable.
Run the Set-VBRObjectStorageBackupJob cmdlet. Set the $Job variable as the Job parameter value. Set the $FilteredObject variable as the BackupObject parameter value.

Related Commands

Get-VBRUnstructuredBackupJob