Syntax
Set-AlarmDefinition [-AlarmDefinition] <AlarmDefinition[]> [-ActionRepeatMinutes <Int32>] [-Description <String>] [-Enabled <Boolean>] [-Name <String>] [-AlarmAction <AlarmAction[]>] [-AlarmTrigger <AlarmTrigger[]>] [-ReportingFrequencyMinutes <Int32>] [-ReportingTolerancePercentage <Int32>] [-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet modifies the specified alarm definitions.Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
AlarmDefinition | AlarmDefinition[] | Specifies the alarm definition you want to modify. | true | True (ByValue) | |
ActionRepeatMinutes | Int32 | Specifies a time period in minutes to define how often the alarm action repeats if the alarm is active. | false | False | |
AlarmAction | AlarmAction[] | Specifies the alarm actions which you want to be executed when the alarm triggers. | false | False | |
AlarmTrigger | AlarmTrigger[] | Specifies the alarm triggers which you can use to activate the alarm. | false | False | |
Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | False | |
Description | String | Specifies a new description for the alarm definition. | false | False | |
Enabled | Boolean | Indicates that the alarm definition is enabled. | false | False | |
Name | String | Specifies a new name for the alarm definition. | false | False | |
ReportingFrequencyMinutes | Int32 | Indicates how often you want to trigger the alarm. It is measured in minutes. | false | False | |
ReportingTolerancePercentage | Int32 | Indicates the tolerance range for the metric triggers. It is measured in percentage. | false | False | |
Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet. | false | False | |
WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
Zero or more modified AlarmDefinition objectsNotes
Examples
-------------------------- Example 1 --------------------------
Get-AlarmDefinition -Name 'alarms' | Set-AlarmDefinition -ActionRepeatMinutes ($_.ActionRepeatMinutes + 1)
Increases all selected alarms action repeat minutes.
-------------------------- Example 2 --------------------------
Get-AlarmDefinition -Name 'alarm' | foreach {$_ | Set-AlarmDefinition -Name 'alarm new name' -Description 'new description' -Enabled:$true}
Changes the name, description, and the Enabled flag of the selected alarms.
-------------------------- Example 3 --------------------------
$trigger = New-AlarmTrigger -StatePath "runtime.powerState" -Value "poweredOff" -EntityStatus Red -EntityType "VirtualMachine" -StateAlarmOperator Equal $action = New-AlarmAction -Snmp Get-AlarmDefinition -Name 'alarm' | Set-AlarmDefinition -Trigger $trigger -Action $action -ReportingFrequencyMinutes 20 -ReportingTolerancePercentage 10
Changes the triggers, actions, reporting frequency minutes, and reporting tolerance percentage of the selected alarm.