Syntax
Get-AlarmTrigger [-AlarmDefinition] <AlarmDefinition[]> [-TriggerType {Unknown | Event | Metric | State}] [-Server <VIServer[]>] [<CommonParameters>]Related Commands
Get-AlarmActionDetailed Description
This cmdlet retrieves alarms triggers. The cmdlet returns a set of triggers that correspond to the filter criteria provided by the cmdlet parameters. To specify a server different from the default one, use the Server parameter.Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
AlarmDefinition | AlarmDefinition[] | Specifies the alarm definitions for which you want to retrieve the triggers. The alarm name could be passed. | true | False | |
Server | VIServer[] | 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. | false | False | |
TriggerType | TriggerType | Specifies the type of the trigger that you want to retrieve. | false | False |
Return Type
VMware.VimAutomation.ViCore.Types.V1.Alarm.AlarmTriggerNotes
Examples
-------------------------- Example 1 --------------------------
Get-AlarmTrigger -AlarmDefinition $alarm
Retrieves all alarm triggers.
-------------------------- Example 1 --------------------------
Get-AlarmTrigger -AlarmDefinition $alarm -TriggerType Event
Retrieves alarm triggers of type Event.