Help Center
Choose product document...
Veeam Backup & Replication 9.5 [Archived]
PowerShell Reference

New-VBRFileToTapeObject

Short Description

Creates a new VBRFileToTapeObject object.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

New-VBRFileToTapeObject [-Server <CHost>] -Path <String> [-IncludeMask <String>] [-Credentials <CCredentials>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet creates a VBRFileToTapeObject object. This object contains 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

Server

Specifies the host where the files reside.

Default: Local.

False

Named

False

False

Path

Specifies the string with the target file path.

False

Named

False

False

Include
Mask

Used to select files by mask if a directory is set as a source.

Specifies the string with the mask by which you want to select files from the directory.

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRFileToTapeObject

Example

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.

PS C:\PS> $server = Get-VBRServer -Name "fileserver08.tech.local"

PS C:\PS> $creds = Get-VBRCredentials -Description "Fileserver08 Adminisrator"

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

Related Commands

Get-VBRServer

Get-VBRCredentials

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide