Syntax
New-AlarmDefinition [-ActionRepeatMinutes <Int32>] [-AlarmAction <AlarmAction[]>] -AlarmTrigger <AlarmTrigger[]> [-Description <String>] [-Disabled] -Entity <VIObject> -Name <String> [-ReportingFrequencyMinutes <Int32>] [-ReportingTolerancePercentage <Int32>] [-WhatIf] [<CommonParameters>]Related Commands
Detailed Description
This cmdlet creates a new alarm definition.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| ActionRepeatMinutes | Int32 | Specifies the frequency in minutes. This indicates how often appropriate actions should be repeated when an alarm does not change its state. | 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. | true | False | |
| Description | String | Specifies the alarm description. | false | False | |
| Disabled | SwitchParameter | Specifies if the alarm is disabled. By default, the alarm is enabled. | false | False | |
| Entity | VIObject | Specifies the entity to which you want to attach the alarm. If you want to specify the root, use the data centers. | true | False | |
| Name | String | Specifies the alarm name. | true | 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 | |
| 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
VMware.VimAutomation.ViCore.Types.V1.Alarm.AlarmDefinitionNotes
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.