New-CMSchedule

New-CMSchedule

Creates a schedule token.

Syntax

Parameter Set: RecurrenceNone
New-CMSchedule -Nonrecurring [-IsUtc] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurMonthlyByWeekday
New-CMSchedule -DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday} -WeekOrder <ScheduleWeekOrder> [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurMonthlyByWeekdayWithDuration
New-CMSchedule -DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday} -DurationCount <Int32> -DurationInterval <ScheduleInterval> -WeekOrder <ScheduleWeekOrder> [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurMonthlyByWeekdayWithEnd
New-CMSchedule -DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday} -End <DateTime> -WeekOrder <ScheduleWeekOrder> [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurMonthlyLastDayOfMonth
New-CMSchedule -LastDayOfMonth [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurMonthlyLastDayOfMonthWithDuration
New-CMSchedule -DurationCount <Int32> -DurationInterval <ScheduleInterval> -LastDayOfMonth [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurMonthlyLastDayOfMonthWithEnd
New-CMSchedule -End <DateTime> -LastDayOfMonth [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceInterval
New-CMSchedule -RecurCount <Int32> -RecurInterval <ScheduleInterval> [-IsUtc] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceIntervalWithDuration
New-CMSchedule -DurationCount <Int32> -DurationInterval <ScheduleInterval> -RecurCount <Int32> -RecurInterval <ScheduleInterval> [-IsUtc] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceIntervalWithEnd
New-CMSchedule -End <DateTime> -RecurCount <Int32> -RecurInterval <ScheduleInterval> [-IsUtc] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceMonthlyByDate
New-CMSchedule -DayOfMonth <Int32> [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceMonthlyByDateWithDuration
New-CMSchedule -DayOfMonth <Int32> -DurationCount <Int32> -DurationInterval <ScheduleInterval> [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceMonthlyByDateWithEnd
New-CMSchedule -DayOfMonth <Int32> -End <DateTime> [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceNoneWithDuration
New-CMSchedule -DurationCount <Int32> -DurationInterval <ScheduleInterval> -Nonrecurring [-IsUtc] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceNoneWithEnd
New-CMSchedule -End <DateTime> -Nonrecurring [-IsUtc] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceWeekly
New-CMSchedule -DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday} [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceWeeklyWithDuration
New-CMSchedule -DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday} -DurationCount <Int32> -DurationInterval <ScheduleInterval> [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Parameter Set: RecurrenceWeeklyWithEnd
New-CMSchedule -DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday} -End <DateTime> [-IsUtc] [-RecurCount <Int32> ] [-ScheduleString] [-Start <DateTime> ] [ <CommonParameters>]

Detailed Description

The New-CMSchedule cmdlet creates a schedule token. In Microsoft System Center 2012 SP1 Configuration Manager, you use schedule tokens to configure scheduling information. You can create schedule tokens to schedule events with differing frequencies such as daily, weekly, and monthly.

Use the Convert-CMSchedule cmdlet to decode and encode schedule tokens into and from an interval string. You can then use the interval strings to set schedule properties when you define or modify System Center 2012 Configuration Manager objects.

Parameters

-DayOfMonth<Int32>

Specifies the day of the month when the event occurs. Valid values range from 0 through 31. The default value is 0, which indicates the last day of the month.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DayOfWeek<DayOfWeek>

Specifies the day of the week when the event occurs. The acceptable values for this parameter are:

-- Sunday (default)
-- Monday
-- Tuesday
-- Wednesday
-- Thursday
-- Friday
-- Saturday

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DurationCount<Int32>

Specifies the number of days during which the scheduled event occurs. Valid values range from 0 through 31. The default value is 0, which indicates that the scheduled action continues indefinitely.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DurationInterval<ScheduleInterval>

Specifies the time when the event occurs.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-End<DateTime>

Specifies the date and time when the scheduled event ends.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-IsUtc

Indicates that the time is Coordinated Universal Time (UTC).

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LastDayOfMonth

Indicates that the event occurs monthly on the last day of the month.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Nonrecurring

Indicates that the scheduled event does not recur.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RecurCount<Int32>

Specifies the number of recurrences of the scheduled event.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RecurInterval<ScheduleInterval>

Specifies the time when the scheduled event recurs.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ScheduleString

Indicates that the schedule token is converted to an interval string.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Start<DateTime>

Specifies the date and time when the scheduled event occurs.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-WeekOrder<ScheduleWeekOrder>

Specifies the week of the month when the event occurs. The acceptable values for this parameter are:

-- 0. Last (default)
-- 1. First
-- 2. Second
-- 3. Third
-- 4. Fourth

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Create a schedule token

This command creates a schedule token that specifies that the event occurs on the last day of the month at the specified date and time.

PS C:\> New-CMSchedule -DayOfMonth 0 -DateTime "20120105185728.303000+000"

Convert-CMSchedule