Set-VBRNASBackupJob
Short Description
Modifies file share backup jobs.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRNASBackupJob -Job <VBRNASBackupJob> [-Name <string>] [-Description <string>] [-BackupObject <VBRNASBackupJobObject[]>] [-ShortTermBackupRepository <CBackupRepository>] [-ShortTermRetentionType <VBRNASBackupShortTermRetentionType> {Daily | Monthly}] [-ShortTermRetentionPeriod <int>] [-EnableLongTermRetention] [-LongTermRetentionType <VBRNASBackupLongTermRetentionType> {Monthly | Yearly}] [-LongTermBackupRepository <CBackupRepository>] [-EnableCopyMode] [-LongTermRetentionPeriod <int>] [-LongTermArchivalOptions <VBRNASBackupArchivalOptions>] [-EnableSecondaryTarget] [-SecondaryTarget <VBRNASBackupSecondaryTarget[]>] [-VersionRetentionOptions <VBRNASBackupVersionRetentionOptions>] [-StorageOptions <VBRStorageOptions>] [-HealthCheckOptions <VBRFullBackupOptions>] [-NotificationOptions <VBRNotificationOptions>] [-ScriptOptions <VBRJobScriptOptions>] [-EnableFileACLChangeTracking] [-EnableSchedule][-ScheduleOptions <VBRServerScheduleOptions>] [-Force] [-HighPriority] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings of existing file share backup jobs.
Note |
To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged. |
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
Job | Specifies the file share backup job. The cmdlet will modify settings of the specified job. | Accepts the VBRNASBackupJob object. To create this object, run the Get-VBRNASBackup cmdlet. | True | Named | True (ByValue, ByPropertyName) |
Name | Specifies a name of the file share backup job. The cmdlet will change the existing name of the file share backup job with the specified name. | String | False | Named | False |
Description | Specifies a description of the file share backup job. The cmdlet will change the existing description of the file share backup job with the specified description. | String | False | Named | False |
BackupObject | Specifies folders and files. The cmdlet will add these folders and files to the file share backup job. | Accepts the VBRNASBackupJobObject[] object. To create this object, run the New-VBRNASBackupJobObject cmdlet. | False | Named | False |
ShortTermBackupRepository | Specifies the backup repository. The cmdlet will add this backup repository as the short-term repository. | Accepts the CBackupRepository object. To create this object, run the Get-VBRBackupRepository cmdlet. | False | Named | False |
ShortTermRetentionType | Specifies a retention policy for the short-term repository. You can set the retention policy to either of the following periods:
Use the ShortTermRetentionPeriod to specify the number of days or months. | Accepts the CBackupRepository object. To create this object, run the Get-VBRBackupRepository cmdlet. | False | Named | False |
ShortTermRetentionPeriod | For the ShortTermRetentionType option. Specifies the period of time to keep data on the short-term repository. When this period is passed, Veeam Backup & Replication will move data to the long-term repository. | Int32 | False | Named | False |
EnableLongTermRetention | Defines that the cmdlet will enable custom retention policy for the long-term repository. If you provide this parameter, Veeam Backup & Replication will apply custom retention policy for data that is stored on the long-term repository. Otherwise, Veeam Backup & Replication will keep data for three years on the long-turn repository. | SwitchParamter | False | Named | False |
LongTermRetentionType | Specifies a retention policy for the long-term repository. You can set the retention policy to either of the following periods:
Use the LongTermRetentionPeriod to specify the number of days or months. | VBRNASBackupLongTermRetentionType | False | Named | False |
LongTermBackupRepository | Specifies the backup repository. The cmdlet will add this backup repository as the long-term repository. | Accepts the CBackupRepository object. To create this object, run the Get-VBRBackupRepository cmdlet. | False | Named | False |
LongTermRetentionPeriod | For the LongTermRetentionType option. Specifies the period of time to keep data on the short-term repository. When this period is passed, Veeam Backup & Replication will delete this data from the long-term repository. | Int32 | False | Named | False |
LongTermArchivalOptions | Specifies the retention policy for file versions that are located on the long-term repository. The cmdlet will create file share backup jobs with the specified retention policy. | Accepts the VBRNASBackupArchivalOptions object. To create this object, run the New-VBRNASBackupArchivalOptions cmdlet. | False | Named | False |
EnableCopyMode | Defines that the cmdlet will keep the copy of the data stored in the backup repository in the long-term archive repository. | SwitchParameter | False | Named | False |
EnableSecondaryTarget | Defines that the cmdlet will enable a secondary backup repository for a file share backup job. If you provide this parameter, Veeam Backup & Replication will create copies of file share backup jobs and will keep them on a secondary backup repository. Otherwise, copies of the file share backup job will not be created. | SwitchParamter | False | Named | False |
SecondaryTarget | Specifies the backup repository. The cmdlet will add this backup repository as the secondary repository to the file share backup job. | Accepts the VBRNASBackupSecondaryTarget[] object. To create this object, run the New-VBRNASBackupSecondaryTarget cmdlet. | False | Named | False |
VersionRetentionOptions | Specifies the settings of version-based retention for backup and archive repositories. The cmdlet will apply these settings to the file share backup job. | Accepts the VBRNASBackupVersionRetentionOptions object. To create this object, run the New-VBRNASBackupVersionRetentionOptions cmdlet.
| False | Named | False |
StorageOptions | Specifies storage optimization settings. The cmdlet will create the file share backup job with these settings. | Accepts the VBRStorageOptions object. To create this object, run the New-VBRStorageOptions cmdlet. | False | Named | False |
HealthCheckOptions | Specifies the healthcheck schedule. The cmdlet will create file share backup jobs with this healthcheck schedule. | Accepts the VBRFullBackupOptions object. To create this object, run the New-VBRFullBackupOptions cmdlet. | False | Named | False |
NotificationOptions | Specifies notification options. The cmdlet will create file share backup jobs with these notification options. | Accepts the VBRNotificationOptions object. To create this object, run the New-VBRFullBackupOptions cmdlet. | False | Named | False |
ScriptOptions | Specifies pre-job and post-job script options. The cmdlet will create file share backup jobs with these script options. | Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRJobScriptOptions cmdlet. | False | Named | False |
EnableFileACLChangeTracking | Defines that Veeam Backup & Replication will process attributes and permissions for folders. Files that are added to these folders will inherit permissions of the folders. If you enable this option, Veeam Backup & Replication will back up folder ACL attributes and permissions. Otherwise, they will not be backed up. | SwitchParamter | False | Named | False |
EnableSchedule | Defines that the cmdlet will enable the custom schedule for a file share backup job. if you provide this parameter, a file share backup job will run according to this schedule. Otherwise, to run the job, you will need to start it manually. | VBRJobScriptOptions | False | Named | False |
ScheduleOptions | Specifies schedule options. The cmdlet will create file share backup jobs with these schedule options. | Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRServerScheduleOptions cmdlet. | False | Named | False |
Force | Indicates that the cmdlet will add create file backup without showing warnings in the PowerShell console. | SwitchParameter | False | Named | False |
HighPriority | Note: This parameter is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261). Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place. | 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.
Output Object
The cmdlet returns the VBRNASBackupJob object that contains settings of file share backup jobs.
Examples
Example 1. Modifying Long-Term Repository
This example shows how to modify a long-term repository for a file share backup job. The file share backup job will have the following settings:
Perform the following steps:
|
Example 2. Modifying Notification Options
This example shows how to modify notification options for a file share backup job. Veeam Backup & Replication will send notifications about the job warnings and when the job completes successfully.
Perform the following steps:
|
Example 3. Enabling Secondary Target Repository
This example shows how to enable the secondary repository for the file share backup job. The secondary repository will be created with the following settings:
Perform the following steps:
|
Related Commands