vSphere PowerCLI Reference

Get-OMAlert

Synopsis

This cmdlet retrieves alerts from the specified vRealize Operations Manager server.

Syntax

Get-OMAlert [-Status <OMAlertStatus[]>] [-Impact <OMImpact[]>] [-Criticality <OMCriticality[]>] [-Resource <OMResource[]>] [-Subtype <OMAlertSubtype[]>] [-AssignedUser <OMUser[]>] [-Type <OMAlertType[]>] [-ControlState <OMAlertControlState[]>] [-AlertDefinition <OMAlertDefinition[]>] [[-Name] <String[]>] [-Server <OMServer[]>] [<CommonParameters>]
Get-OMAlert -Id <String[]> [-Server <OMServer[]>] [<CommonParameters>]

Related Commands

Online version
Set-OMAlert

Detailed Description

This cmdlet retrieves alerts from the specified vRealize Operations Manager server.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Filters the alerts by name.falsefalse
AlertDefinitionOMAlertDefinition[]Filters the alerts by definition.falsetrue (ByValue)
AssignedUserOMUser[]Filters the alerts by the user who owns the alert.falsetrue (ByValue)
ControlStateOMAlertControlState[]Filters the alerts by the state of user interaction with the alert. For example, the state can be Open, Assigned, or Suspended.falsefalse
CriticalityOMCriticality[]Filters the alerts by level of importance. The possible values are None, Information, Warning, Immediate, Critical, SymptomBased, and Unknown.falsefalse
IdString[]Filters the alerts by ID.truefalse
ImpactOMImpact[]Filters the alerts by level of urgency. The possible values are Health, Risk, Efficiency, and Unknown.falsefalse
ResourceOMResource[]Filters the alerts by the resource for which the alert was raised.falsetrue (ByValue)
ServerOMServer[]Specifies the vRealize Operations Manager 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.falsefalse
StatusOMAlertStatus[]Filters the alerts by current state. The possible values are Active, Inactive, and Unknown.falsefalse
SubtypeOMAlertSubtype[]Filters the alerts by the subtype of the alert.falsefalse
TypeOMAlertType[]Filters the alerts by the type of the alert.falsefalse

Return Type

Zero or more OMAlert objects

Notes

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.


Copyright © VMware, Inc. All rights reserved.