Set-VBRFileToTapeJob
Short Description
Modifies a file to tape job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRFileToTapeJob -Job <VBRFileToTapeJob> [-Name <String>] [-Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [-FullBackupMediaPool <VBRTapeMediaPool>] [-IncrementalBackupMediaPool <VBRTapeMediaPool>] [-ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFileToTapeBackupPolicy>] [-IncrementalBackupPolicy <VBRFileToTapeBackupPolicy>] [-Object <VBRFileToTapeObject[]>] [-NdmpObject <VBRNDMPVolume[]>] [-UseVSS] [-UseHardwareCompression] [-NotificationOptions] [-JobScriptOptions] [-PassThru] [-Force] [-EnableParallelDrivesUsage] [-LimitTapeDrives <Int32>] [-EnableFileAclChangeTracking] [<CommonParameters>] |
Detailed Description
This cmdlet modifies a selected file to tape job that was created before.
Note |
To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged. |
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
Job | Specifies the file to tape job to which you want to apply new settings. | Accepts the following objects:
| True | Named | True (ByValue, |
Name | Specifies the name you want to assign to the file to tape job. | String | True | Named | False |
Description | Specifies the description of the file to tape job. | String | False | Named | False |
EjectCurrentMedium | Defines that the tapes will be automatically ejected from drive after the job finishes. The ejected tape is moved to a standard library slot. | SwitchParameter | False | Named | False |
ExportCurrentMediaSet | Defines that the tapes belonging to the media set will be automatically placed to Import/Export (Mail) slot for further export. Use the ExportDays parameter to set days on which you want to export tapes. If you use this parameter, but do not set the ExportDays parameter, the tapes will be exported every day. | SwitchParameter | False | Named | False |
FullBackupMediaPool | Specifies the media pool where you want to store full backups produced by this tape job. | Accepts the VBRTapeMediaPool object, GUID or string. To get this object, run the Get-VBRTapeMediaPool cmdlet. | True | Named | False |
IncrementalBackupMediaPool | Used to set media pool for the ProcessIncrementalBackup parameter. Specifies the media pool where you want to store incremental backups produced by this tape job. If you do not specify a media pool, incremental backups will be stored to the media pool the you set for full backups. | Accepts the VBRTapeMediaPoolBase object, GUID or string. To get this object, run the Get-VBRTapeMediaPool cmdlet. | False | Named | False |
ExportDays | Used to set days for exporting tapes for the ExportCurrentMediaSet parameter. Specifies days on which the tapes written by this tape job will be automatically exported: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. | DayOfWeek[] | False | Named | False |
FullBackupPolicy | Specifies virtualized synthetic full backup for tape settings. Default:
| Accepts the VBRFullBackupToTapePolicy object. to create this object, run the New-VBRFullBackupToTapePolicy cmdlet. | False | Named | False |
IncrementalBackupPolicy | Specifies incremental backup settings. Default:
| Accepts the VBRTapeMediaPoolBase object, GUID or string. To get this object, run the Get-VBRTapeMediaPool cmdlet. | False | Named | False |
Object | Specifies the array of file to tape job sources. | Accepts the VBRFileToTapeJob object. To get this object, run the Get-VBRTapeJob cmdlet. | False | Named | False |
NdmpObject | Specifies an array of NDMP server volumes. | Accepts the VBRNDMPVolume[] object. Run the Get-VBRNDMPVolume cmdlet to get this object. | False | Named | False |
UseVSS | Defines that the VSS (Microsoft Volume Shadow Copy) must be used. Default: true. Note: To disable this option, set the parameter value to $false. That is, parameter_name:$false. | SwitchParameter | False | Named | False |
UseHardwareCompression | Defines that tape library must perform hardware compression for archives. Do not use this option for archiving Veeam backups or other already compressed files. | SwitchParameter | False | Named | False |
NotificationOptions | Specifies the email notification options. | Accepts the VBRNotificationOptions object. To create this object, run the New-VBRNotificationOptions cmdlet. | False | Named | False |
JobScriptOptions | Specifies scripting options. | Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRJobScriptOptions cmdlet. | False | Named | False |
PassThru | Defines that the command returns the output object to the Windows PowerShell console. | SwitchParameter | False | Named | False |
Force | Defines that the cmdlet will update a job even if the geographic location of the repositories where VM backups reside and the target media pool location do not match. | SwitchParameter | False | Named | False |
EnableParallelDrivesUsage | Enables parallel processing of media pools. Default: False. | SwitchParameter | False | Named | False |
LimitTapeDrives | Defines that the cmdlet will limit the number of drives to use for processing this tape job. Default: 2 drives. | Int32 | False | Named | False |
EnableFileAclChangeTracking | Enables backup of permissions and attributes for files. Default: False. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
Examples
Changing Media Pool for File to Tape Job [Using Pipeline]
This example shows how to set a new media pool for the full backups for the File Backup to Tape job.
$newpool = Get-VBRTapeMediaPool -Name "File Backups" Get-VBRTapeJob -Name "File Backup to Tape" | Set-VBRFileToTapeJob -FullBackupMediaPool $newpool |
Perform the following steps:
- Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save it to the $newpool variable.
- Run the Get-VBRTapeJob cmdlet. Specify the Name parameter value.
- Pipe the cmdlet output to the Set-VBRFileToTapeJob cmdlet. Set the $newpool variable as the FullBackupMediaPool parameter value.
Related Commands
