Set-AlarmDefinition

This cmdlet modifies the specified alarm definitions.

Syntax

-AlarmDefinition  <AlarmDefinition[]>
[-ActionRepeatMinutes  <Int32>]
[-AlarmAction  <AlarmAction[]>]
[-AlarmTrigger  <AlarmTrigger[]>]
[-Description  <String>]
[-Enabled  <Boolean>]
[-Name  <String>]
[-ReportingFrequencyMinutes  <Int32>]
[-ReportingTolerancePercentage  <Int32>]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
AlarmDefinition
AlarmDefinition[] named
  • pipeline
  • Specifies the alarm definition you want to modify.
    optional
    ActionRepeatMinutes
    Int32 named Specifies a time period in minutes to define how often the alarm action repeats if the alarm is active.
    optional
    AlarmAction
    AlarmAction[] named Specifies the alarm actions which you want to be executed when the alarm triggers.
    optional
    AlarmTrigger
    AlarmTrigger[] named Specifies the alarm triggers which you can use to activate the alarm.
    optional
    Description
    String named Specifies a new description for the alarm definition.
    optional
    Enabled
    Boolean named Indicates that the alarm definition is enabled.
    optional
    Name
    String named Specifies a new name for the alarm definition.
    optional
    ReportingFrequencyMinutes
    Int32 named Indicates how often you want to trigger the alarm. It is measured in minutes.
    optional
    ReportingTolerancePercentage
    Int32 named Indicates the tolerance range for the metric triggers. It is measured in percentage.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Alarm.AlarmDefinition

    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.

    Related Commands

    Feedback

    Was this page helpful?