Set-VBRServerScheduleOptions

In this article

    Short Description

    Modifies the schedule for Veeam Agent backup jobs.

    Applies to

    Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Set-VBRServerScheduleOptions -Options <VBRServerScheduleOptions> [-Type <VBRServerScheduleType> {Daily | Monthly |Periodically | AfterJob}] [-DailyOptions <VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>][-PeriodicallyOptions <VBRPeriodicallyOptions>] [-Job <CBackupJob>] [-EnableRetry] [-RetryCount <int>]
    [-RetryTimeout <int>] [-EnableBackupTerminationWindow] [-TerminationWindow <VBRBackupWindowOptions>][<CommonParameters>]

    Detailed Description

    This cmdlet modifies schedule settings for the following types of jobs:

    • Veeam Agent jobs that back up Linux servers.
    • Veeam Agent jobs that back up failover clusters.
    • Veeam Agent jobs that back up Windows servers.
    • The backup policy that Veeam Agent job applies to Windows servers.

    To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Set-VBRServerScheduleOptions Note:

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Options

    Specifies the server schedule settings that you want to modify.

    Accepts the VBRServerScheduleOptions type.

    True

    Named

    True (ByValue)

     

    Type

    Specifies the Veeam Agent backup job schedule type.

    • Daily: use this option to run the job at a specific time daily.
    • Monthly: use this option to run the job once a month on specific days.
    • Periodically: use this option to run the job repeatedly throughout a day with a specific time interval.
    • AfterJob: use this option to create a chain of jobs. Veeam Backup & Replication will start the Veeam Agent Backup job after the other backup job.
      NOTE: The AfterJob option does not work for backup policy.

    False

    Named

    False

     

    DailyOptions

    For daily schedule.

    Specifies daily schedule settings. The cmdlet will create the server schedule with these settings.

    Accepts the VBRDailyOptions type

    False

    Named

    False

     

    MonthlyOptions

    For monthly schedule.

    Specifies monthly schedule settings. The cmdlet will create the server schedule with these settings.

    Accepts the VBRMonthlyOptions type.

    False

    Named

    False

     

    PeriodicallyOptions

    For periodical run.

    Specifies periodical schedule settings. The cmdlet will create the server schedule with these settings.

    Accepts the VBRPeriodicallyOptions type.

    False

    Named

    False

     

    Job

    For running after a job.

    Specifies the name of the backup job after which Veeam Backup & Replication will run Veeam Agent backup jobs. The cmdlet will create the server schedule with these settings.

    False

    Named

    False

     

    EnableRetry

    Indicates that Veeam Backup & Replication will attempt to run the Veeam Agent backup job again in case it fails.

    False

    Named

    False

     

    RetryCount

    For the EnableRetry parameter.

    Specifies the number of attempts to run the failed Veeam Agent backup job.

    False

    Named

    False

     

    RetryTimeout

    For the EnableRetry parameter.

    Specifies the time interval between retry attempts in minutes.

    False

    Named

    False

     

    EnableBackupTerminationWindow

    Defines that Veeam Backup & Replication will stop the Veeam Agent backup job if it exceeds the backup window.

    False

    Named

    False

     

    TerminationWindow

    Specifies the time interval within which the backup job must complete. The cmdlet will create the Veeam Agent backup job with these settings.

    Accepts the VBRBackupWindowOptions type.

    False

    Named

    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

    Example

    This example shows how to modify an existing schedule for a Veeam Agent backup job.

    1. Run Get-VBRComputerBackupJob to get the backup job that you want to modify. Save the result to the $job variable.
    2. Run New-VBRServerScheduleOptions to define the schedule for a job. Save the result to the $options variable.
    3. Run New-VBRPeriodicallyOptions to specify options for periodical job run. Save the result to the $period variable.
    4. Run New-VBRBackupWindowOptions to specify termination window settings. Save the result to the $termination variable.
    5. Run Set-VBRServerScheduleOptions with the $schedule, $period and $termination variables. Set the Periodically value for the Type parameter to change the schedule type from daily to periodical.

    $job = Get-VBRComputerBackupJob -name "BackupJob"

    $options = New-VBRServerScheduleOptions -Type Daily -DailyOptions $daily

    $termination = New-VBRBackupWindowOptions -FromDay Friday -FromHour 17 -ToDay Monday -ToHour 8

    Set-VBRServerScheduleOptions -Options $options -Type Periodically -PeriodicallyOptions $period -EnableBackupTerminationWindow -TerminationWindow $termination

    Related Commands

    New-VBRDailyOptions

    New-VBRServerScheduleOptions

    New-VBRPeriodicallyOptions

    New-VBRBackupWindowOptions