New-VBRFileToTapeObject

Short Description

Defines settings of the source for the files to tape job.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides cmdlet sets that allow you to:

  • Define backup servers as a source for file to tape jobs.

New-VBRFileToTapeObject -Path <string> [-Server <CHost>] [-IncludeMask <string>] [-ExcludeMask <string>] [-Credentials <CCredentials>]  [<CommonParameters>]

  • Define shared folders as a source for file to tape jobs;

New-VBRFileToTapeObject [-NASServer <VBRNASServer>] [-IncludeMask <string>] [-ExcludeMask <string>][<CommonParameters>]

Detailed Description

This cmdlet creates the VBRFileToTapeObject object. This object contains settings of files or directories that you want to add to a file to tape job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Path

Specifies the target file path.

True

Named

False

False

Server

Specifies the host where the files reside.

Default: Local.

False

Named

False

False

NASServer

Specifies network shared folders. Veeam Backup & Replication will back up these shared folders with the file to tape job.

Accepts the VBRNASServer object. Run the Get-VBRNASServer cmdlet, to get this object.

Note: Currently this parameter accepts only the NFS and SMB file share types. File servers are not supported.

False

Named

False

False

IncludeMask

Specifies files that you want to back up with the file to tape job.

False

Named

False

False

ExcludeMask

Specifies files that you want to exclude from the file to tape job.

False

Named

False

False

Credentials

Specifies the credentials you want to use to authenticate with the host.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRFileToTapeObject

Examples

This command creates an object for a file to tape job. The object contains a folder on the server named "fileserver08".

  1. Run Get-VBRServer to get the server where the files are located. Save it to the $server variable.
  2. Run Get-VBRCredentials to get the credentials to access the Fileserver08. Save the credentials to the $creds variable.
  3. Run New-VBRFileToTapeObject with the saved variables.

$server = Get-VBRServer -Name "fileserver08.tech.local"

$creds = Get-VBRCredentials -Description "Fileserver08 Adminisrator"

New-VBRFileToTapeObject -Server $server -Path "D:\Summary Reports\Payroll Reports" -Credentials $creds

Related Commands

Get-VBRServer

Get-VBRCredentials