Set-VBRObjectStorageBackupJobObject

Short Description

Modifies settings of objects that will be added to the object storage backup job.

Note

This cmdlet is available starting from Veeam Backup & Replication 12.1 (build 12.1.0.2131).

Applies to

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

Syntax

Set-VBRObjectStorageBackupJobObject -JobObject <VBRObjectStorageBackupJobObject> [-InclusionMask <VBRObjectStorageBackupMask[]>] [-ExclusionMask <VBRObjectStorageBackupMask[]>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of objects that will be added to the object storage backup job.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
JobObject	Specifies the settings of objects that will be added to the object storage backup job. The cmdlet will modify these settings.	Accepts the VBRObjectStorageBackupJobObject object. To define this object, run the New-VBRObjectStorageBackupJobObject cmdlet.	True	Named	True (ByValue, ByPropertyName)
InclusionMask	Specifies a file mask for objects that you want to add to the object storage backup job. The cmdlet will back up only objects specified in this file mask.	Accepts the VBRObjectStorageBackupMask[] object. To get this object, run the New-VBRObjectStorageBackupTagMask cmdlet.	False	Named	False
ExclusionMask	Specifies a file mask for objects that you do not want to add to the object storage backup job. The cmdlet will not back up these objects.	Accepts the VBRObjectStorageBackupMask[] object. To get this object, run the following cmdles: New-VBRObjectStorageBackupContainerPathMask New-VBRObjectStorageBackupServerPathMask New-VBRObjectStorageBackupTagMask (for include and exclude).	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

JobObject

Specifies the settings of objects that will be added to the object storage backup job. The cmdlet will modify these settings.

Accepts the VBRObjectStorageBackupJobObject object. To define this object, run the New-VBRObjectStorageBackupJobObject cmdlet.

True

Named

True (ByValue, ByPropertyName)

InclusionMask

Specifies a file mask for objects that you want to add to the object storage backup job. The cmdlet will back up only objects specified in this file mask.

Accepts the VBRObjectStorageBackupMask[] object. To get this object, run the New-VBRObjectStorageBackupTagMask cmdlet.

False

Named

False

ExclusionMask

Specifies a file mask for objects that you do not want to add to the object storage backup job. The cmdlet will not back up these objects.

Accepts the VBRObjectStorageBackupMask[] object. To get this object, run the following cmdles:

New-VBRObjectStorageBackupContainerPathMask
New-VBRObjectStorageBackupServerPathMask
New-VBRObjectStorageBackupTagMask (for include and exclude).

False

Named

False

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

Output Object

The cmdlet returns the VBRObjectStorageBackupJobObject object that contains settings of objects that will be added to the object storage backup job.

Examples

Defining Objects to Exclude from Object Storage Backup Job

This example shows how to exclude the Path Reports/.pdf from object storage backup job.

$serv = Get-VBRUnstructuredServer -Name "Azure OS"

$object = New-VBRObjectStorageBackupJobObject -Server $serv -Container "Monthly Backups" -Path "Reports"

$ExclusionMask = New-VBRObjectStorageBackupContainerPathMask -Container "Monthly Backups" -Path Reports/.pdf'

Set-VBRObjectStorageBackupJobObject -JobObject $object -ExclusionMask $ExclusionMask

Perform the following steps:

Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter value. Save the result to the $serv variable.
Run the New-VBRObjectStorageBackupJobObject cmdlet. Specify the Server, Container and the Path parameter values. Save the result to the $object variable.
Run the New-VBRObjectStorageBackupContainerPathMask cmdlet. Specify the Container and the Path parameter values. Save the result to the $ExclusionMask variable.
Run the Set-VBRObjectStorageBackupJobObject cmdlet. Set the $object variable as the JobObject parameter value. Set the $ExclusionMask variable as the ExclusionMask parameter value.

Related Commands