Syntax
Get-OMAlert [[-Name] <String[]>] [-AlertDefinition <OMAlertDefinition[]>] [-AssignedUser <OMUser[]>] [-ControlState <OMAlertControlState[]>] [-Criticality <OMCriticality[]>] [-Impact <OMImpact[]>] [-Resource <OMResource[]>] [-Server <OMServer[]>] [-Status <OMAlertStatus[]>] [-Subtype <OMAlertSubtype[]>] [-Type <OMAlertType[]>] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet retrieves alerts from the specified vRealize Operations Manager server.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Filters the alerts by name. | false | False | |
| AlertDefinition | OMAlertDefinition[] | Filters the alerts by definition. | false | True (ByValue) | |
| AssignedUser | OMUser[] | Filters the alerts by the user who owns the alert. | false | True (ByValue) | |
| ControlState | OMAlertControlState[] | Filters the alerts by the state of user interaction with the alert. For example, the state can be Open, Assigned, or Suspended. | false | False | |
| Criticality | OMCriticality[] | Filters the alerts by level of importance. The possible values are None, Information, Warning, Immediate, Critical, SymptomBased, and Unknown. | false | False | |
| Id | String[] | Filters the alerts by ID. | true | False | |
| Impact | OMImpact[] | Filters the alerts by level of urgency. The possible values are Health, Risk, Efficiency, and Unknown. | false | False | |
| Resource | OMResource[] | Filters the alerts by the resource for which the alert was raised. | false | True (ByValue) | |
| Server | OMServer[] | 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. | false | False | |
| Status | OMAlertStatus[] | Filters the alerts by current state. The possible values are Active, Inactive, and Unknown. | false | False | |
| Subtype | OMAlertSubtype[] | Filters the alerts by the subtype of the alert. | false | False | |
| Type | OMAlertType[] | Filters the alerts by the type of the alert. | false | False |
Return Type
Zero or more OMAlert objectsNotes
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.