Syntax
New-AlarmActionTrigger [-StartStatus] <InventoryItemStatus> [-EndStatus] <InventoryItemStatus> -AlarmAction <AlarmAction> [-Repeat] [-Confirm] [-WhatIf] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet creates a new action trigger for the specified alarm action.Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
StartStatus | InventoryItemStatus | Specifies the start status for the alarm action. The valid values are Green, Yellow, and Red. | true | False | |
EndStatus | InventoryItemStatus | Specifies the end status for the alarm action. The valid values are Green, Yellow, and Red. | true | False | |
AlarmAction | AlarmAction | Specifies the alarm action for which you want to create an action trigger. | true | True (ByValue) | |
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 | |
Repeat | SwitchParameter | Indicates whether you want the alarm action to repeat until the alarm is acknowledged. | 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
The newly created AlarmActionTrigger objectNotes
Examples
-------------------------- Example 1 --------------------------
Get-AlarmDefinition -Name "Alarm1" | Get-AlarmAction | New-AlarmActionTrigger -StartStatus 'Red' -EndStatus 'Yellow' -Repeat
Creates an action trigger for all actions for the specified alarm definition.