Get-OMAlertDefinition
This cmdlet retrieves alert definitions from the specified VMware Aria Operations 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.
Syntax
[-Criticality <OMCriticality[]>]
[-Impact <OMImpact[]>]
[-Name <String[]>]
[-ResourceKind <String[]>]
[-Server <OMServer[]>]
[-SubType <OMAlertSubtype[]>]
[-Type <OMAlertType[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
String[] | named |
|
Filters the alert definitions by the type of adapter that manages the selected base object type. | optional |
|
OMCriticality[] | named |
|
Filters the alert definitions by level of importance. The possible values are None, Information, Warning, Immediate, Critical, SymptomBased, and Unknown. | optional |
|
OMImpact[] | named |
|
Filters the alert definitions by level of urgency. The possible values are Health, Risk, Efficiency, and Unknown. | optional |
|
String[] | named |
|
Filters the alert definitions by the name of the alert. | optional |
|
String[] | named |
|
Filters the alert definitions by the type of the resource for which the alert was raised. | optional |
|
OMServer[] | named |
|
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. | optional |
|
OMAlertSubtype[] | named |
|
Filters the alert definitions by the subtype of the alert. | optional |
|
OMAlertType[] | named |
|
Filters the alert definitions by the type of the alert. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Filters the alert definitions by ID. | optional |
|
OMServer[] | named |
|
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. |
Output
VMware.VimAutomation.vROps.Types.V1.OMAlertDefinition
Examples
Example 1
Retrieves all alert definitions of a specified criticality.
Example 2
Lists all alert definitions that contain the string storage in the name.
Example 3
Retrieves all alert definitions by defined type and subtype.
Example 4
Retrieves all alert definitions for vCenter Server VirtualMachine objects.
Related Commands
OMAlert
OMAlertDefinition
OMAlertSubType
