< Back
Set-AMScheduleCondition
Post
NAME Set-AMScheduleCondition
SYNOPSIS
Sets properties of an AutoMate Enterprise schedule condition.
SYNTAX
Set-AMScheduleCondition [-InputObject] <Object> [[-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>] [[-CompletionState] {InDevelopment | Testing | Production | Archive}] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Sets-AMScheduleCondition modifies an existing schedule condition.
PARAMETERS
-InputObject <Object>
The condition to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ScheduleType
Set the schedule to use a Custom interval.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NextLaunchDate <DateTime>
The next time the schedule will execute
Required? false
Position? 3
Default value
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? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Day
The day(s) of the week to execute the schedule on.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-End <DateTime>
The last date the schedule will execute.
Required? false
Position? 6
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? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Month <String[]>
The month(s) to execute.
Required? false
Position? 8
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? 9
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-OnTaskLate
The action to take when the task is late.
Required? false
Position? 10
Default value RunImmediately
Accept pipeline input? false
Accept wildcard characters? false
-Reschedule
Specify how the schedule should be rescheduled.
Required? false
Position? 11
Default value RelativeToOriginalTime
Accept pipeline input? false
Accept wildcard characters? false
-Notes <String>
The new notes to set on the object.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionState
The completion state (staging level) to set on the object.
Required? false
Position? 13
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:\\># Set schedule "Daily at 8PM" to disable the trigger when late
Get-AMCondition "Daily at 8PM" | Set-AMScheduleCondition -ScheduleType Day -OnTaskLate DisableTrigger
RELATED LINKS
https://github.com/AutomatePS/AutomatePS
SYNOPSIS
Sets properties of an AutoMate Enterprise schedule condition.
SYNTAX
Set-AMScheduleCondition [-InputObject] <Object> [[-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>] [[-CompletionState] {InDevelopment | Testing | Production | Archive}] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Sets-AMScheduleCondition modifies an existing schedule condition.
PARAMETERS
-InputObject <Object>
The condition to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ScheduleType
Set the schedule to use a Custom interval.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NextLaunchDate <DateTime>
The next time the schedule will execute
Required? false
Position? 3
Default value
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? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Day
The day(s) of the week to execute the schedule on.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-End <DateTime>
The last date the schedule will execute.
Required? false
Position? 6
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? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Month <String[]>
The month(s) to execute.
Required? false
Position? 8
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? 9
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-OnTaskLate
The action to take when the task is late.
Required? false
Position? 10
Default value RunImmediately
Accept pipeline input? false
Accept wildcard characters? false
-Reschedule
Specify how the schedule should be rescheduled.
Required? false
Position? 11
Default value RelativeToOriginalTime
Accept pipeline input? false
Accept wildcard characters? false
-Notes <String>
The new notes to set on the object.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionState
The completion state (staging level) to set on the object.
Required? false
Position? 13
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:\\># Set schedule "Daily at 8PM" to disable the trigger when late
Get-AMCondition "Daily at 8PM" | Set-AMScheduleCondition -ScheduleType Day -OnTaskLate DisableTrigger
RELATED LINKS
https://github.com/AutomatePS/AutomatePS