Get-AlarmAction
This cmdlet retrieves the actions of the specified alarm definitions.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | ActionType | ActionType[] | named |
|
Specifies the type of the alarm actions you want to retrieve. The valid values are SendEmail, ExecuteScript, and Send SNMP. |
| optional | AlarmDefinition | AlarmDefinition[] | named |
|
Specifies the alarm definitions for which you want to retrieve the configured actions. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
Output
VMware.VimAutomation.ViCore.Types.V1.Alarm.AlarmActionExamples
Example 1
Get-AlarmDefinition -Name "Host processor status" | Get-AlarmAction -ActionType "ExecuteScript", "SendSNMP", "SendEmail"
Extract all PowerCLI supported alarm actions for the default alarm "Host processor status".
Example 2
Get-AlarmAction -AlarmDefinition "Host processor status" -ActionType "SendSNMP" -Server 'server IP'
Extract the alarm actions for the default alarm "Host processor status" by specifying the alarm by name.
Related Commands
AlarmAction
This cmdlet retrieves the actions of the specified alarm definitions.
This cmdlet creates an alarm action and attaches it to the specified alarm.
This cmdlet removes an alarm action.
AlarmActionTrigger
This cmdlet retrieves the actions that trigger the specified alarm actions.
This cmdlet creates a new action trigger for the specified alarm action.
This cmdlet removes the alarm action triggers.
AlarmDefinition
This cmdlet retrieves the available alarm definitions.
This cmdlet creates a new alarm definition.
This cmdlet removes alarm definitions from the vSphere environment.
This cmdlet modifies the specified alarm definitions.
AlarmTrigger
This cmdlet retrieves alarms triggers.
This cmdlet adds ? new alarm trigger to the existing alarm or creates ? new alarm trigger.
AlarmTriggerArgument
This cmdlet creates a new AlarmTriggerArgument local object that defines the condition comparison under which an alarm is triggered. The AlarmTriggerArgument object is used as the Arguments parameter in the New-AlarmTrigger cmdlet.
AlarmTriggerArgumentAttributeName
This cmdlet fetches a list of attribute names of the alarm trigger argument for the "vsan.health.ssd.endurance" event type. (The most of attribute names for alarm trigger argument can be fetched by Get-EventType)