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 parameter 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>] [-Path <String>] [-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

Type

Required

Position

Accept
Pipeline
Input

Path

Specifies the target file path.

String

True/False

Named

False

Server

Specifies the host where the files reside.

Default: Local.

Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

False

Named

False

NASServer

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

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

Accepts the VBRNASServer object. To get this object, run the Get-VBRUnstructuredServer cmdlet.

False

Named

False

IncludeMask

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

String

False

Named

False

ExcludeMask

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

String

False

Named

False

Credentials

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

Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.

False

Named

False

<CommonParameters>

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

Output Object

VBRFileToTapeObject

Examples

Creating Object for File to Tape Job

This example shows how to create an object for a file to tape job. The object contains a folder on the fileserver08 server.

$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

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Get-VBRCredentials cmdlet. Specify the Description parameter value. Save the result to the $creds variable.
  3. Run the New-VBRFileToTapeObject cmdlet. Set the $server variable as the Server parameter value. Specify the Path parameter value. Set the $creds variable as the Credentials parameter value.

Related Commands