< Back
Set-AMTaskProperty
Post
NAME Set-AMTaskProperty
SYNOPSIS
Sets the task properties of an AutoMate Enterprise task.
SYNTAX
Set-AMTaskProperty [-InputObject] <Object> [-ErrorNotificationPropertiesSpecified] [[-ErrorNotifyEmailFromAddress]
<String>] [[-ErrorNotifyEmailToAddress] <String>] [-ExecutionPropertiesSpecified] [[-TaskExecutionSpeed] <Int32>]
[-CanStopTask] [-IsolationPropertiesSpecified] [[-Isolation] {Default | Always | Never}]
[-LogonPropertiesSpecified] [[-OnLocked] {LoggedonUser | SpecifiedUser | BackgroundUser | DoNotRun}] [[-OnLogged]
{LoggedonUser | SpecifiedUser | BackgroundUser | DoNotRun}] [[-OnLogoff] {LoggedonUser | SpecifiedUser |
BackgroundUser | DoNotRun}] [-UseLogonDefault] [[-LogonUsername] <String>] [[-LogonPassword] <String>]
[[-LogonDomain] <String>] [-RunAsElevated] [-PriorityPropertiesSpecified] [[-Priority] {AlwaysRun |
RunningInstancesBelowThreshold | RunningTasksBelowThreshold | RunWithNoOtherTasks}] [[-PriorityAction] {Hold |
DoNotRun | HoldInterrupt | HoldTimeout | InterruptTasks | InterruptInstances}] [[-MaxTaskInstances] <Int32>]
[[-PriorityWaitTimeOut] <Int32>] [[-TaskFailureAction] {Success | Failure | ReturnResult}] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Set-AMTaskProperty modifies task properties.
PARAMETERS
-InputObject <Object>
The workflow property to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ErrorNotificationPropertiesSpecified [<SwitchParameter>]
Override the error property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ErrorNotifyEmailFromAddress <String>
The error email sender.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ErrorNotifyEmailToAddress <String>
The error email recipient.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ExecutionPropertiesSpecified [<SwitchParameter>]
Override the execution property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-TaskExecutionSpeed <Int32>
The speed in milliseconds that the the task should wait between steps.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-CanStopTask [<SwitchParameter>]
Whether a user can stop the running task.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IsolationPropertiesSpecified [<SwitchParameter>]
Override the isolation property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Isolation
The task isolation level.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonPropertiesSpecified [<SwitchParameter>]
Override the logon property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-OnLocked
The action to take when the workstation is locked.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OnLogged
The action to take when the workstation is logged on.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OnLogoff
The action to take when the workstation is logged off.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UseLogonDefault [<SwitchParameter>]
Whether the task should run as the default agent user, or the specified user.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LogonUsername <String>
The username to login as.
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonPassword <String>
The password for the specified user.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonDomain <String>
The domain for the specified user.
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RunAsElevated [<SwitchParameter>]
Whether the task should run with elevated rights.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-PriorityPropertiesSpecified [<SwitchParameter>]
Override the priority property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Priority
The task priority level.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PriorityAction
The action to take if the priority level is not met.
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxTaskInstances <Int32>
The task instance threshold for the priority action specified.
Required? false
Position? 14
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-PriorityWaitTimeOut <Int32>
The timeout in minutes to use if the priority action allows for timeout.
Required? false
Position? 15
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TaskFailureAction
If the priority is not met, the status to set on the task.
Required? false
Position? 16
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
RELATED LINKS
https://github.com/AutomatePS/AutomatePS
SYNOPSIS
Sets the task properties of an AutoMate Enterprise task.
SYNTAX
Set-AMTaskProperty [-InputObject] <Object> [-ErrorNotificationPropertiesSpecified] [[-ErrorNotifyEmailFromAddress]
<String>] [[-ErrorNotifyEmailToAddress] <String>] [-ExecutionPropertiesSpecified] [[-TaskExecutionSpeed] <Int32>]
[-CanStopTask] [-IsolationPropertiesSpecified] [[-Isolation] {Default | Always | Never}]
[-LogonPropertiesSpecified] [[-OnLocked] {LoggedonUser | SpecifiedUser | BackgroundUser | DoNotRun}] [[-OnLogged]
{LoggedonUser | SpecifiedUser | BackgroundUser | DoNotRun}] [[-OnLogoff] {LoggedonUser | SpecifiedUser |
BackgroundUser | DoNotRun}] [-UseLogonDefault] [[-LogonUsername] <String>] [[-LogonPassword] <String>]
[[-LogonDomain] <String>] [-RunAsElevated] [-PriorityPropertiesSpecified] [[-Priority] {AlwaysRun |
RunningInstancesBelowThreshold | RunningTasksBelowThreshold | RunWithNoOtherTasks}] [[-PriorityAction] {Hold |
DoNotRun | HoldInterrupt | HoldTimeout | InterruptTasks | InterruptInstances}] [[-MaxTaskInstances] <Int32>]
[[-PriorityWaitTimeOut] <Int32>] [[-TaskFailureAction] {Success | Failure | ReturnResult}] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Set-AMTaskProperty modifies task properties.
PARAMETERS
-InputObject <Object>
The workflow property to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-ErrorNotificationPropertiesSpecified [<SwitchParameter>]
Override the error property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ErrorNotifyEmailFromAddress <String>
The error email sender.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ErrorNotifyEmailToAddress <String>
The error email recipient.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ExecutionPropertiesSpecified [<SwitchParameter>]
Override the execution property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-TaskExecutionSpeed <Int32>
The speed in milliseconds that the the task should wait between steps.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-CanStopTask [<SwitchParameter>]
Whether a user can stop the running task.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IsolationPropertiesSpecified [<SwitchParameter>]
Override the isolation property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Isolation
The task isolation level.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonPropertiesSpecified [<SwitchParameter>]
Override the logon property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-OnLocked
The action to take when the workstation is locked.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OnLogged
The action to take when the workstation is logged on.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-OnLogoff
The action to take when the workstation is logged off.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UseLogonDefault [<SwitchParameter>]
Whether the task should run as the default agent user, or the specified user.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-LogonUsername <String>
The username to login as.
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonPassword <String>
The password for the specified user.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogonDomain <String>
The domain for the specified user.
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RunAsElevated [<SwitchParameter>]
Whether the task should run with elevated rights.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-PriorityPropertiesSpecified [<SwitchParameter>]
Override the priority property inheritance.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Priority
The task priority level.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PriorityAction
The action to take if the priority level is not met.
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MaxTaskInstances <Int32>
The task instance threshold for the priority action specified.
Required? false
Position? 14
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-PriorityWaitTimeOut <Int32>
The timeout in minutes to use if the priority action allows for timeout.
Required? false
Position? 15
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TaskFailureAction
If the priority is not met, the status to set on the task.
Required? false
Position? 16
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
RELATED LINKS
https://github.com/AutomatePS/AutomatePS