New-VBRNASBackupPathMask

Short Description

Defines an exclusion mask for path for a file 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

This cmdlet provides parameter sets that allow you to:

  • Exclude the whole file share.

New-VBRNASBackupPathMask [-ForAllShares]  [<CommonParameters>]

  • Exclude certain folder.

New-VBRNASBackupPathMask -Path <string> [-ForAllShares]  [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRNASBackupPathMask object. This object defines an exclusion path for mask for a file backup job. You can exclude either a specific folder or the whole file share.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Path

Specifies a path to the folder that you want to exclude.

String

True

Named

True (ByValue, ByPropertyName)

ForAllShares

Defines that the cmdlet will exclude multiple paths under file shares.

Note: You can exclude multiples paths for only for root file shares.

SwitchParameter

False

Named

False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRNASBackupPathMask object that defines an exclusion path for mask for a file backup job.

Examples

New-VBRNASBackupPathMaskExample 1. Defining Exclusion Paths for File Backup Job

This command defines the \\EV-NIMBLE\SMB_Share\New Inc-Exc exclusion path.

$exclusionMask = New-VBRNASBackupPathMask -Path "\\EV-NIMBLE\SMB_Share\New Inc-Exc"

New-VBRNASBackupPathMaskExample 2. Defining Exclusion Paths for Multiple File Shares

This command defines that the New Inc-Exc folder will be excluded from all file shares.

$exclusionMask = New-VBRNASBackupPathMask -Path "New Inc-Exc" -ForAllShares