New-AlarmDefinition

This cmdlet creates a new alarm definition.

Syntax

-AlarmTrigger  <AlarmTrigger[]>
-Entity  <VIObject>
-Name  <String>
[-ActionRepeatMinutes  <Int32>]
[-AlarmAction  <AlarmAction[]>]
[-Description  <String>]
[-Disabled]
[-ReportingFrequencyMinutes  <Int32>]
[-ReportingTolerancePercentage  <Int32>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
AlarmTrigger
AlarmTrigger[] named Specifies the alarm triggers which you can use to activate the alarm.
required
Entity
VIObject named Specifies the entity to which you want to attach the alarm. If you want to specify the root, use the data centers.
required
Name
String named Specifies the alarm name.
optional
ActionRepeatMinutes
Int32 named Specifies the frequency in minutes. This indicates how often appropriate actions should be repeated when an alarm does not change its state.
optional
AlarmAction
AlarmAction[] named Specifies the alarm actions which you want to be executed when the alarm triggers.
optional
Description
String named Specifies the alarm description.
optional
Disabled
SwitchParameter named Specifies if the alarm is disabled. By default, the alarm is enabled.
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.

Output

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

Examples


Example 1

New-AlarmDefinition -Name "AlarmName" -AlarmTrigger $alarmTriggers -Entity $entity

Creates an enabled alarm definition with the "AlarmName" name and a collection of $alarmTriggers triggers for the $entity.

Example 2

New-AlarmDefinition -Name "AlarmName" - AlarmTrigger $alarmTriggers -AlarmAction $alarmAction -Entity $entity -Description "alarm definition description" -ActionRepeatMinutes 20 -ReportingFrequencyMinutes 30 -ReportingTolerancePercentage 10 -Disabled

Creates a disabled alarm definition with the "AlarmName" name, an "alarm definition description" description, and a collection of $alarmTriggers triggers for the $entity. The newly created alarm definition has alarm actions: $alarm Action. The alarm action repeat minutes are 20, the reporting frequency minutes are 30, and the reporting tolerance range is 10.

Related Commands

Feedback

Was this page helpful?