PowerCLI Reference

Get-OMAlertDefinition

Synopsis

This cmdlet retrieves alert definitions from the specified vRealize Operations Manager server.

Syntax

Get-OMAlertDefinition [-Impact <OMImpact[]>] [-Criticality <OMCriticality[]>] [-ResourceKind <String[]>] [-AdapterKind <String[]>] [-Type <OMAlertType[]>] [-SubType <OMAlertSubtype[]>] [[-Name] <String[]>] [-Server <OMServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Get-OMAlertDefinition -Id <String[]> [-Server <OMServer[]>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Related Commands

Online version

Detailed Description

This cmdlet retrieves alert definitions from the specified vRealize Operations Manager server. The alert definition is a template that contains a set of symptoms, recommendations, and actions. When at least one symptom is breached, an alert with the same name as the alert definition is generated.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Filters the alert definitions by the name of the alert.	false	false
AdapterKind	String[]	Filters the alert definitions by the type of adapter that manages the selected base object type.	false	false
Criticality	OMCriticality[]	Filters the alert definitions by level of importance. The possible values are None, Information, Warning, Immediate, Critical, SymptomBased, and Unknown.	false	false
Id	String[]	Filters the alert definitions by ID.	true	false
Impact	OMImpact[]	Filters the alert definitions by level of urgency. The possible values are Health, Risk, Efficiency, and Unknown.	false	false
InformationAction	ActionPreference		false	false
InformationVariable	String		false	false
PipelineVariable	String		false	false
ResourceKind	String[]	Filters the alert definitions by the type of the resource for which the alert was raised.	false	false
Server	OMServer[]	Specifies the Operations Management server from which you want to retrieve alerts. The value can be the connection object returned by the Connect-OMServer cmdlet or the object's name, which can be the IP or DNS address of the server machine.	false	false
SubType	OMAlertSubtype[]	Filters the alert definitions by the subtype of the alert.	false	false
Type	OMAlertType[]	Filters the alert definitions by the type of the alert.	false	false

Return Type

Zero or more OMAlertDefinition objects

Notes

Examples

-------------- Example 1 --------------

Get-OMAlertDefinition -Criticality Critical

Retrieves all alert definitions of a specified criticality.

-------------- Example 2 --------------

Get-OMAlertDefinition -Name *storage*

Lists all alert definitions that contain the string storage in the name.

-------------- Example 3 --------------

$alertType = Get-OMAlertType -Name 'Network Alerts'
$alertSubType = Get-OMAlertSubType -Id 'ID'
Get-OMAlertDefinition -Type $alertType -SubType $alertSubType

Retrieves all alert definitions by defined type and subtype.

-------------- Example 4 --------------

Get-OMAlertDefinition -AdapterKind VMWARE -ResourceKind VirtualMachine

Retrieves all alert definitions for vCenter Server VirtualMachine objects.