< Back
Set-AMPerformanceCondition
Post
NAME Set-AMPerformanceCondition
SYNOPSIS
Sets properties of an AutoMate Enterprise performance condition.
SYNTAX
Set-AMPerformanceCondition [-InputObject] <Object> [[-MachineName] <String>] [[-CategoryName] <String>]
[[-CounterName] <String>] [[-InstanceName] <String>] [[-Operator] {Below | Above}] [[-Amount] <Int32>]
[[-TimePeriod] <Int32>] [[-TimePeriodUnit] {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-AMPerformanceCondition modifies an existing performance condition.
PARAMETERS
-InputObject <Object>
The condition to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-MachineName <String>
The computer to check performance counters on.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CategoryName <String>
The system category in which to monitor (i.e. Processor, Memory, Paging File, etc.). A category catalogues
performance counters in a logical unit.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CounterName <String>
The type of counter related to the category in which to monitor. Performance counters are combined together
under categories. They are used to measure various aspects of performance, such as transfer rates for disks
or, for processors, the amount of processor time consumed. Specific counters are populated in this section
depending on the performance category selected.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstanceName <String>
The instance related to the category in which to monitor. A performance counter can be divided into instances,
such as processes, threads, or physical units.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Operator
Above or Below.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Amount <Int32>
The threshold to trigger on.
Required? false
Position? 7
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimePeriod <Int32>
The amount of time to wait before triggering.
Required? false
Position? 8
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimePeriodUnit
The unit of time for TriggerWhenTimePeriod.
Required? false
Position? 9
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? 10
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutUnit
The unit for Timeout (Seconds by default).
Required? false
Position? 11
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? 12
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Notes <String>
The new notes to set on the object.
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionState
The completion state (staging level) to set on the object.
Required? false
Position? 14
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 performance condition.
SYNTAX
Set-AMPerformanceCondition [-InputObject] <Object> [[-MachineName] <String>] [[-CategoryName] <String>]
[[-CounterName] <String>] [[-InstanceName] <String>] [[-Operator] {Below | Above}] [[-Amount] <Int32>]
[[-TimePeriod] <Int32>] [[-TimePeriodUnit] {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-AMPerformanceCondition modifies an existing performance condition.
PARAMETERS
-InputObject <Object>
The condition to modify.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-MachineName <String>
The computer to check performance counters on.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CategoryName <String>
The system category in which to monitor (i.e. Processor, Memory, Paging File, etc.). A category catalogues
performance counters in a logical unit.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CounterName <String>
The type of counter related to the category in which to monitor. Performance counters are combined together
under categories. They are used to measure various aspects of performance, such as transfer rates for disks
or, for processors, the amount of processor time consumed. Specific counters are populated in this section
depending on the performance category selected.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InstanceName <String>
The instance related to the category in which to monitor. A performance counter can be divided into instances,
such as processes, threads, or physical units.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Operator
Above or Below.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Amount <Int32>
The threshold to trigger on.
Required? false
Position? 7
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimePeriod <Int32>
The amount of time to wait before triggering.
Required? false
Position? 8
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimePeriodUnit
The unit of time for TriggerWhenTimePeriod.
Required? false
Position? 9
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? 10
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-TimeoutUnit
The unit for Timeout (Seconds by default).
Required? false
Position? 11
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? 12
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Notes <String>
The new notes to set on the object.
Required? false
Position? 13
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CompletionState
The completion state (staging level) to set on the object.
Required? false
Position? 14
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