Export-VBRJobObjectMasks

Short Description

Exports masks of objects for file backup jobs and object storage backup jobs.

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

Syntax

Export-VBRJobObjectMasks -BackupObject <VBRUnstructuredBackupJobObject> -Job <CBackupJob> -Path <String>

[-Force] [<CommonParameters>]

Detailed Description

This cmdlet exports masks of objects for file backup jobs and object storage backup jobs.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
BackupObject	Specifies a scope of objects. The cmdlet will export masks that contains these objects. Accepts the `VBRUnstructuredBackupJobObject` object. To create this object, run the following cmdlets: [For a file backup job] `New-VBRNASBackupJobObject` [For object storage backup job] `New-VBRObjectStorageBackupJobObject`	`VBRUnstructuredBackupJobObject`	True	Named	False
Force	Defines that the cmdlet will export masks without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
Job	Specifies an array of of file backups job and object storage backup job. The cmdlet will return masks added to these jobs. Accepts the `CBackupJob` object. To get this object, run the `Get-VBRUnstructuredBackupJob` cmdlet.	`CBackupJob`	True	Named	False
Path	Specifies a path to a folder. The cmdlet will export masks to this folder.	`String`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Output Object

VBRImportedUnstructuredBackupMasks

Examples

Exporting Masks for Object Storage Backup Job

This example shows how to exports masks for the Azure backup object storage backup jobs.

$Job = Get-VBRUnstructuredBackupJob -Name "filemasks"

$BackupObjects = $Job.BackupObject

Export-VBRJobObjectMasks -Job $Job -BackupObject $BackupObjects[0] -Path "C:\export.xml"

Perform the following steps:

Run the Get-VBRUnstructuredBackupJob cmdlet. Specify the Name parameter value. Save the result to the $Job variable.
Get the BackupObject property of the $Job variable value. Save result to the $BackupObjects variable.
Run the Export-VBRJobObjectMasks cmdlet. Set the $Job variable as the Job parameter value. Set the $BackupObjects[0] variable as the BackupObject parameter value. Specify the Path parameter value.