PowerCLI Reference



This cmdlet modifies the specified alarm definitions.


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 Version

Detailed Description

This cmdlet modifies the specified alarm definitions.


NameTypeDescriptionRequired?Pipeline InputDefault Value
AlarmDefinitionAlarmDefinition[]Specifies the alarm definition you want to modify.trueTrue (ByValue)
ActionRepeatMinutesInt32Specifies a time period in minutes to define how often the alarm action repeats if the alarm is active.falseFalse
AlarmActionAlarmAction[]Specifies the alarm actions which you want to be executed when the alarm triggers.falseFalse
AlarmTriggerAlarmTrigger[]Specifies the alarm triggers which you can use to activate the alarm.falseFalse
ConfirmSwitchParameterIf 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.falseFalse
DescriptionStringSpecifies a new description for the alarm definition.falseFalse
EnabledBooleanIndicates that the alarm definition is enabled.falseFalse
NameStringSpecifies a new name for the alarm definition.falseFalse
ReportingFrequencyMinutesInt32Indicates how often you want to trigger the alarm. It is measured in minutes.falseFalse
ReportingTolerancePercentageInt32Indicates the tolerance range for the metric triggers. It is measured in percentage.falseFalse
ServerVIServer[]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.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

Zero or more modified AlarmDefinition objects



-------------------------- 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.

Copyright © VMware, Inc. All rights reserved.