< Back

New-AMScheduleCondition

Sat Jan 11, 2020 3:01 am

NAME New-AMScheduleCondition



SYNOPSIS

Creates a new AutoMate Enterprise schedule condition.





SYNTAX

New-AMScheduleCondition [-Name] <String> [-ScheduleType {Custom | SecondInterval | MinuteInterval | HourInterval |

DayInterval | WeekInterval | MonthInterval | Holidays}] [-NextLaunchDate <DateTime>] [-Frequency <Object>] [-Day

{Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-End <DateTime>] [-Measure {Day | WorkDay

| Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-Month <String[]>] [-MonthInterval

<Int32>] [-OnTaskLate {RunImmediately | IgnoreAndReschedule | DisableTrigger}] [-Reschedule

{RelativeToOriginalTime | RelativeToTriggeredTime | DisableTrigger}] [-Notes <String>] [-Folder <Object>]

[-Connection <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

New-AMScheduleCondition creates a new schedule condition.





PARAMETERS

-Name <String>

The name of the new object.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ScheduleType

Set the schedule to use a Custom interval.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-NextLaunchDate <DateTime>

The next time the schedule will execute



Required? false

Position? named

Default value (Get-Date)

Accept pipeline input? false

Accept wildcard characters? false



-Frequency <Object>

How frequently the schedule should execute the specified interval. For example: every 1 day, every 2 days, etc.



Required? false

Position? named

Default value 1

Accept pipeline input? false

Accept wildcard characters? false



-Day

The day(s) of the week to execute the schedule on.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-End <DateTime>

The last date the schedule will execute.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Measure

When using the -MonthInterval option, use this parameter to specify regular days, work days, or a specific

weekday (i.e. Monday, Tuesday, etc.).



Required? false

Position? named

Default value Day

Accept pipeline input? false

Accept wildcard characters? false



-Month <String[]>

The month(s) to execute.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-MonthInterval <Int32>

The frequency to execute when using a "Specific day(s) of the month" schedule type.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-OnTaskLate

The action to take when the task is late.



Required? false

Position? named

Default value RunImmediately

Accept pipeline input? false

Accept wildcard characters? false



-Reschedule

Specify how the schedule should be rescheduled.



Required? false

Position? named

Default value RelativeToOriginalTime

Accept pipeline input? false

Accept wildcard characters? false



-Notes <String>

The new notes to set on the object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Folder <Object>

The folder to place the object in.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Object>

The server to create the object on.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\># Create a new schedule to run every day at 8AM



New-AMScheduleCondition -Name "Daily at 8AM" -DayInterval -NextLaunchDate (Get-Date "8:00AM")









-------------------------- EXAMPLE 2 --------------------------



PS C:\\># Create a new schedule to run every other month on the third Wednesday at 9PM



New-AMScheduleCondition -Name "Third Wednesday" -MonthInterval -Measure Wednesday -DayOfMonth third -Frequency 2

-NextLaunchDate (Get-Date "9:00PM")











RELATED LINKS

https://github.com/AutomatePS/AutomatePS