< Back
Set-AMIdleCondition
Post
NAME Set-AMIdleCondition
SYNOPSIS
Sets properties of an AutoMate Enterprise idle condition.
SYNTAX
Set-AMIdleCondition [-InputObject] <Object> [[-Delay] <Int32>] [[-Measure] {Seconds | Minutes | Hours | Days |
Milliseconds}] [-Wait] [[-Timeout] <Int32>] [[-TimeoutUnit] {Seconds | Minutes | Hours | Days | Milliseconds}]
[[-TriggerAfter] <Int32>] [[-Notes] <String>] [[-CompletionState] {InDevelopment | Testing | Production |
Archive}] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Set-AMIdleCondition modifies an existing idle condition.
PARAMETERS
-InputObject <Object>
The condition to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Delay <Int32>
The duration the agent must be idle before triggering this condition.
Required? false
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Measure
The unit for Delay (Minutes by default).
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Wait [<SwitchParameter>]
Wait for the condition, or evaluate immediately.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
If wait is specified, the amount of time before the condition times out.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutUnit
The unit for Timeout (Seconds by default).
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TriggerAfter <Int32>
The number of times the condition should occur before the trigger fires.
Required? false
Position? 6
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Notes <String>
The new notes to set on the object.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionState
The completion state (staging level) to set on the object.
Required? false
Position? 8
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 properties of an AutoMate Enterprise idle condition.
SYNTAX
Set-AMIdleCondition [-InputObject] <Object> [[-Delay] <Int32>] [[-Measure] {Seconds | Minutes | Hours | Days |
Milliseconds}] [-Wait] [[-Timeout] <Int32>] [[-TimeoutUnit] {Seconds | Minutes | Hours | Days | Milliseconds}]
[[-TriggerAfter] <Int32>] [[-Notes] <String>] [[-CompletionState] {InDevelopment | Testing | Production |
Archive}] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Set-AMIdleCondition modifies an existing idle condition.
PARAMETERS
-InputObject <Object>
The condition to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Delay <Int32>
The duration the agent must be idle before triggering this condition.
Required? false
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Measure
The unit for Delay (Minutes by default).
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Wait [<SwitchParameter>]
Wait for the condition, or evaluate immediately.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
If wait is specified, the amount of time before the condition times out.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutUnit
The unit for Timeout (Seconds by default).
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TriggerAfter <Int32>
The number of times the condition should occur before the trigger fires.
Required? false
Position? 6
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Notes <String>
The new notes to set on the object.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionState
The completion state (staging level) to set on the object.
Required? false
Position? 8
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