Get-OMAlertDefinition Command | Vmware PowerCLI Reference

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

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

Parameters

Required Parameter Name Type Position Features Description
optional AdapterKind String[] named
Filters the alert definitions by the type of adapter that manages the selected base object type.
optional Criticality OMCriticality[] named
Filters the alert definitions by level of importance. The possible values are None, Information, Warning, Immediate, Critical, SymptomBased, and Unknown.
optional Impact OMImpact[] named
Filters the alert definitions by level of urgency. The possible values are Health, Risk, Efficiency, and Unknown.
optional Name String[] named
  • wildcards
 Filters the alert definitions by the name of the alert.
optional ProgressAction ActionPreference named
optional ResourceKind String[] named
Filters the alert definitions by the type of the resource for which the alert was raised.
optional Server 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 SubType OMAlertSubtype[] named
Filters the alert definitions by the subtype of the alert.
optional Type OMAlertType[] named
Filters the alert definitions by the type of the alert.
Get-OMAlertDefinition
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < OMServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
Filters the alert definitions by ID.
optional ProgressAction ActionPreference named
optional Server 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 

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.

Related Commands

OMAlert

This cmdlet retrieves alerts from the specified VMware Aria Operations server.

This cmdlet configures VMware Aria Operations alerts.

OMAlertDefinition

This cmdlet retrieves alert definitions from the specified VMware Aria Operations server.

OMAlertSubType

This cmdlet retrieves alert subtypes from the specified VMware Aria Operations server.

OMAlertType

This cmdlet retrieves alert types from the specified VMware Aria Operations server.