PowerCLI Reference

Get-AlarmTrigger

Synopsis

This cmdlet retrieves alarms triggers.

Syntax

Get-AlarmTrigger [-AlarmDefinition] <AlarmDefinition[]> [-TriggerType {Unknown | Event | Metric | State}] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Get-AlarmAction
Get-AlarmActionTrigger
Get-AlarmDefinition
Get-AlarmTrigger
New-AlarmAction
New-AlarmActionTrigger
New-AlarmDefinition
New-AlarmTrigger
Remove-AlarmAction
Remove-AlarmActionTrigger
Remove-AlarmDefinition
Set-AlarmDefinition
Get-Metric
Get-EventType

Detailed 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

NameTypeDescriptionRequired?Pipeline InputDefault Value
AlarmDefinitionAlarmDefinition[]Specifies the alarm definitions for which you want to retrieve the triggers. The alarm name could be passed.trueFalse
ServerVIServer[]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.falseFalse
TriggerTypeTriggerTypeSpecifies the type of the trigger that you want to retrieve.falseFalse

Return Type

VMware.VimAutomation.ViCore.Types.V1.Alarm.AlarmTrigger

Notes

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.


Copyright © VMware, Inc. All rights reserved.