< Back

Get-AlarmAction

Sun Jan 19, 2020 6:48 pm

NAME Get-AlarmAction



SYNOPSIS

This cmdlet retrieves the actions of the specified alarm definitions.





SYNTAX

Get-AlarmAction [[-AlarmDefinition] <AlarmDefinition[]>] [-ActionType <ActionType[]>] [-Server <VIServer[]>]

[<CommonParameters>]





DESCRIPTION

This cmdlet retrieves the actions of the specified alarm definitions.





PARAMETERS

-ActionType <ActionType[]>

Specifies the type of the alarm actions you want to retrieve. The valid values are SendEmail, ExecuteScript,

and Send SNMP.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AlarmDefinition <AlarmDefinition[]>

Specifies the alarm definitions for which you want to retrieve the configured actions.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Server <VIServer[]>

Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more AlarmAction objects







NOTES









-------------------------- 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 LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... ction.html

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