New-VBRServerScheduleOptions

In this article

    Short Description

    Creates the schedule for jobs.

    Applies to

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

    Syntax

    New-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 creates the VBRServerScheduleOptions object that contains schedule settings for backup jobs.

    You can use this cmdlet to create a schedule 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 the Veeam Agent job applies to Windows servers.
    • File backup jobs.
    • vDC replica jobs.

    New-VBRServerScheduleOptions Note:

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Type

    Specifies the 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.

    True

    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.

    Default: 3.

    False

    Named

    False

    RetryTimeout

    For the EnableRetry parameter.

    Specifies the time interval between retry attempts in minutes.

    Default: 30.

    False

    Named

    False

    EnableBackupTerminationWindow

    Indicates 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 create the server schedule for a Veeam Agent backup job. The job will run on Fridays at 7:00 PM.

    1. Run New-VBRDailyOptions to specify the daily schedule options. Save the result to the $daily variable.
    2. Run New-VBRServerScheduleOptions with the $daily variable. Use the Type parameter to specify the type of the schedule.

    $daily = New-VBRDailyOptions -DayOfWeek Friday -Period 7:00

    New-VBRServerScheduleOptions -Type Daily -DailyOptions $daily

    Related Commands

    New-VBRDailyOptions

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.