New-VBRMonthlyOptions

In this article

    Short Description

    Creates a new VBRMonthlyOptions object.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    New-VBRMonthlyOptions [-Period <TimeSpan>] [-DayNumberInMonth <VBRDayNumberInMonth>] [-DayOfWeek <DayOfWeek>] [-Months <VBRMonth[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet creates an object containing job monthly schedule settings. You can use this object to set job schedule.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Period

    Specifies the time when the job will start.

    Default: 22:00.

    False

    Named

    False

    False

    DayNumberInMonth

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

    • First: the job will run on the first (Saturday) of selected months.
    • Second: the job will run on the second (Saturday) of selected months.
    • Third: the job will run on the third (Saturday) of selected months.
    • Forth: the job will run on the forth (Saturday) of selected months.
    • Last: the job will run on the last (Saturday) of selected months.

    Default: Forth.

    False

    Named

    False

    False

    DayOfWeek

    Specifies the week day for the DayNumberInMonth parameter.

    Default: Saturday.

    False

    Named

    False

    False

    Months

    Specifies the months on which the job will run: January, February, March, April, May, June, July, August, September, October, November, December.

    Default: all months.

    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

    VBRMonthlyOptions

    Example 1

    This command creates the schedule for a job to run at 23:00 on the second Wednesday every month.

    New-VBRMonthlyOptions -DayNumberInMonth Second -DayOfWeek Wednesday -Period 23:00

    Example 2

    This command creates the schedule for a job to run at 10:00 on the last Sunday of January and July.

    New-VBRMonthlyOptions -DayNumberInMonth Last -DayOfWeek Sunday -Period 10:00 -Months January, July