Set-VBRTapeGFSScheduleOptions

In this article

    Short Description

    Modifies VBRTapeGFSScheduleOptions object.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Set-VBRTapeGFSScheduleOptions -Options <VBRTapeGFSScheduleOptions> [-WeeklyDay <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-WeeklyStartAt <timespan>] [-MonthlyKind <VBRGFSMonthlyKind> {DayOfWeek | DayOfMonth}] [-MonthlyDayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-MonthlyDayOfWeekNumber <VBRDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [-MonthlyDayOfMonth <string>] [-QuarterlyKind <VBRGFSQuarterlyKind> {DayOfWeek | DayOfQuarter}] [-QuarterlyDayOfWeekNumber <VBRDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [-QuarterlyDayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-QuarterlyDayOfMonth <string>] [-QuarterlyMonthOfQuarter <VBRGFSMonthOfQuarter> {First | Last}] [-YearlyKind <VBRGFSYearlyKind> {DayOfWeek | DayOfYear}] [-YearlyDayOfWeekNumber <VBRDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [-YearlyDayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-YearlyDayOfMonth <string>] [-MonthOfYear <VBRMonth> {January | February | March | April | May | June | July | August | September | October | November | December}]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies the VBRTapeGFSScheduleOptions object. This object contains GFS scheduling options and is used to set schedule to GFS jobs.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Options

    Specifies the VBRTapeGFSScheduleOptions object you want to modify.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    WeeklyDay

    For weekly backup.

    Specifies the day of week when the weekly backup is archived.

    False

    Named

    False

    False

    WeeklyStartAt

    For weekly backup.

    Specifies the time when the weekly backup is archived.

    False

    Named

    False

    False

    MonthlyKind

    For monthly backup.

    Specifies the type of monthly schedule:

    • DayOfWeek: The monthly backup will be archived on a selected week day in month, for example, every first Sunday of month. Use the MonthlyDayOfWeek parameter to set the day of week and the MonthlyDayOfWeekNumber parameter to set the number of day, for example, "first" (Sunday).
    • DayOfMonth: The monthly backup will be archived on a selected day of month, for example, on the 1st. Use the MonthlyDayOfMonth parameter to set the day.

    False

    Named

    False

    False

    MonthlyDayOfWeek

    For monthly backup.

    Specifies the day of week for the MonthlyKind (DayOfWeek) parameter.

    False

    Named

    False

    False

    MonthlyDayOfWeekNumber

    For monthly backup.

    Specifies the number of day in month (for example, Saturday):

    • First: the job will create a full backup every first (Saturday) of month.
    • Second: the job will create a full backup every first (Saturday) of month.
    • Third: the job will create a full backup every first (Saturday) of month.
    • Forth: the job will create a full backup every first (Saturday) of month.
    • Last: the job will create a full backup every first (Saturday) of month.

    False

    Named

    False

    False

    MonthlyDayOfMonth

    For monthly backup.

    Specifies the day in month for the MonthlyKind (DayOfMonth) parameter: 1-31/Last.

    False

    Named

    False

    False

    QuarterlyKind

    For quarterly backup.

    Specifies the type of quarterly schedule:

    • DayOfWeek: The quarterly backup will be archived on a selected week day, for example, the first Sunday of a quarter. Use the QuarterlyDayOfWeekNumber parameter to set the number of the week day and the QuarterlyDayOfWeek parameter to set the day of week.
    • DayOfQuarter: The quarterly backup will be archived on a selected day of month, for example, on the 1st of the first month of a quarter. Use the QuarterlyDayOfQuarter parameter to set the day of month and the QuartetlyMonthOfQuarter to set the month.

    False

    Named

    False

    False

    QuarterlyDayOfWeekNumber

    For quarterly backup.

    Specifies the number of the selected day, for example, "the first" (Sunday) for the QuarterlyKind (DayOfWeek) parameter: First/Second/Third/Fourth/Last.

    False

    Named

    False

    False

    QuarterlyDayOfWeek

    For quarterly backup.

    Specifies the day of week for the QuarterlyKind (DayOfWeek) parameter.

    False

    Named

    False

    False

    QuarterlyDayOfMonth

    For quarterly backup.

    Specifies the day of month for the QuarterlyKind (DayOfQuarter) parameter: 1-31/Last.

    False

    Named

    False

    False

    QuarterlyMonthOfQuarter

    For quarterly backup.

    Specifies the number of month in quarter for the QuarterlyKind (DayOfQuarter) parameter: First/Last.

    False

    Named

    False

    False

    YearlyKind

    For yearly backup.

    Specifies the type of yearly schedule:

    • DayOfWeek: The yearly backup will be archived on a selected week day in year, for example, every first Sunday of year. Use the YearlyDayOfWeek parameter to set the day of week and the YearlyDayOfWeekNumber parameter to set the number of day, for example, "first" (Sunday).
    • DayOfYear: The yearly backup will be archived on a selected day of month in year, for example, on the 1st of January. Use the YearlyDayOfMonth parameter to set the day in month and the MonthOfYear parameter to set the month.

    False

    Named

    False

    False

    YearlyDayOfWeekNumber

    For yearly backup.

    Specifies the number of the selected day, for example, "the first" (Sunday) for the YearlyKind (DayOfWeek) parameter: First/Second/Third/Fourth/Last.

    False

    Named

    False

    False

    YearlyDayOfWeek

    For yearly backup.

    Specifies the day of week for the YearlyKind (DayOfWeek) parameter.

    False

    Named

    False

    False

    YearlyDayOfMonth

    For yearly backup.

    Specifies the day of month for the YearlyKind (DayOfYear) parameter: 1-31/Last.

    False

    Named

    False

    False

    MonthOfYear

    For yearly backup.

    Specifies the month for the YearlyKind (MonthOfYear) parameter.

    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

    VBRTapeGFSScheduleOptions

    I want to report a typo

    There is a misspelling right here:

     

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