Get-OMAlert

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

Syntax

Get-OMAlert

[-AlertDefinition < OMAlertDefinition[] > ]

[-AssignedUser < OMUser[] > ]

[-ControlState < OMAlertControlState[] > ]

[-Criticality < OMCriticality[] > ]

[-Impact < OMImpact[] > ]

[-Name < String[] > ]

[-ProgressAction < ActionPreference > ]

[-Resource < OMResource[] > ]

[-Server < OMServer[] > ]

[-Status < OMAlertStatus[] > ]

[-Subtype < OMAlertSubtype[] > ]

[-Type < OMAlertType[] > ]

[CommonParameters]

Parameters

Required	Parameter Name	Type	Position	Features	Description
optional	AlertDefinition	OMAlertDefinition[]	named	pipeline	Filters the alerts by definition.
optional	AssignedUser	OMUser[]	named	pipeline	Filters the alerts by the user who owns the alert.
optional	ControlState	OMAlertControlState[]	named		Filters the alerts by the state of user interaction with the alert. For example, the state can be Open, Assigned, or Suspended.
optional	Criticality	OMCriticality[]	named		Filters the alerts by level of importance. The possible values are None, Information, Warning, Immediate, Critical, SymptomBased, and Unknown.
optional	Impact	OMImpact[]	named		Filters the alerts by level of urgency. The possible values are Health, Risk, Efficiency, and Unknown.
optional	Name	String[]	named	wildcards	Filters the alerts by name.
optional	ProgressAction	ActionPreference	named
optional	Resource	OMResource[]	named	pipeline	Filters the alerts by the resource for which the alert was raised.
optional	Server	OMServer[]	named		Specifies the VMware Aria Operations 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	Status	OMAlertStatus[]	named		Filters the alerts by current state. The possible values are Active, Inactive, and Unknown.
optional	Subtype	OMAlertSubtype[]	named		Filters the alerts by the subtype of the alert.
optional	Type	OMAlertType[]	named		Filters the alerts by the type of the alert.

Get-OMAlert

-Id < String[] >

[-ProgressAction < ActionPreference > ]

[-Server < OMServer[] > ]

[CommonParameters]

Parameters

Required	Parameter Name	Type	Position	Description
required	Id	String[]	named	Filters the alerts by ID.
optional	ProgressAction	ActionPreference	named
optional	Server	OMServer[]	named	Specifies the VMware Aria Operations 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.OMAlert

Examples

Example 1

$resource = Get-OMResource -Name 'MyResource'
Get-OMAlert -Resource $resource -Status Active

Retrieves all active alerts for a given resource.

Example 2

Get-OMAlert -Criticality Critical -Status Active

Retrieves all active alerts of a specified criticality.

Example 3

$user = Get-OMUser -Name 'MyUser'
Get-OMAlert -AssignedUser $user

Lists all alerts assigned to a specified user.

Related Commands

OMAlert

Get-OMAlert

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

Set-OMAlert

This cmdlet configures VMware Aria Operations alerts.

OMAlertDefinition

Get-OMAlertDefinition

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

OMAlertSubType

Get-OMAlertSubType

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

OMAlertType

Get-OMAlertType

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