Set-VBRFileToTapeJob
Short Description
Modifies 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. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
Job | Specifies the file to tape job to which you want to apply new settings. Accepts VBRFileToTapeJob or TapeJob, GUID or string type. | True | Named | True (ByValue, | False |
Name | Specifies the name you want to assign to the file to tape job. | True | Named | False | False |
Description | Specifies the description of the file to tape job. | False | Named | False | False |
EjectCurrentMedium | Indicates that the tapes will be automatically ejected from drive after the job finishes. The ejected tape is moved to a standard library slot. | False | Named | False | False |
ExportCurrentMediaSet | Indicates 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. | False | Named | False | False |
FullBackupMediaPool | Specifies the media pool where you want to store full backups produced by this tape job. Accepts VBRTapeMediaPool, GUID or string type. | True | Named | False | 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. Accepts VBRTapeMediaPool, GUID or string type. If you do not specify a media pool, incremental backups will be stored to the media pool the you set for full backups. | False | Named | False | 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. | False | Named | False | False |
FullBackupPolicy | Specifies virtualized synthetic full backup for tape settings. Accepts VBRFileToTapeBackupPolicy type. Default:
| False | Named | False | False |
IncrementalBackupPolicy | Specifies incremental backup settings. Accepts VBRFileToTapeBackupPolicy type. Default:
| False | Named | False | False |
Object | Specifies the array of file to tape job sources. Accepts VBRFileToTapeJob type. | False | Named | False | 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 | False |
UseVSS | Indicates that the VSS (Microsoft Volume Shadow Copy) must be used. Default: true. | False | Named | False | False |
UseHardwareCompression | Indicates that tape library must perform hardware compression for archives. Do not use this option for archiving Veeam backups or other already compressed files. | False | Named | False | False |
NotificationOptions | Specifies the email notification options. Accepts VBRNotificationOptions type. | False | Named | False | False |
JobScriptOptions | Specifies scripting options. Accepts VBRJobScriptOptions type. | False | Named | False | False |
PassThru | Indicates that the command returns the output object to the Windows PowerShell console. | False | Named | False | False |
Force | Indicates that the cmdlet will update a job even if the geographical location of the repositories where VM backups reside and the target media pool location do not match. | False | Named | False | False |
EnableParallelDrivesUsage | Enables parallel processing of media pools. Default: False. | False | Named | False | False |
LimitTapeDrives | Defines that the cmdlet will limit the number of drives to use for processing this tape job. Default: 2 drives. | False | Named | False | False |
EnableFileAclChangeTracking | Enables backup of permissions and attributes for files. Default: False. | 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
Example
This command sets a new media pool for the full backups.
- Run Get-VBRTapeMediaPool. Save it to the $newpool variable.
- Run Set-VBRBackupToTapeJob. Get the job with Get-VBRTapeJob and pipe it down. Use the $newpool variable.
$newpool = Get-VBRTapeMediaPool -Name "File Backups" Get-VBRTapeJob -Name "File Backup to Tape" | Set-VBRFileToTapeJob -FullBackupMediaPool $newpool |
Related Commands