PowerCLI Reference



This cmdlet configures vRealize Operations Manager alerts.


Set-OMAlert [-Alert] <OMAlert[]> -Cancel [-Server <OMServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-OMAlert [-Alert] <OMAlert[]> -ReleaseOwnership [-Server <OMServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-OMAlert [-Alert] <OMAlert[]> [-Server <OMServer[]>] -SuspendMinutes <Int32> [-Confirm] [-WhatIf] [<CommonParameters>]

Set-OMAlert [-Alert] <OMAlert[]> [-Server <OMServer[]>] -TakeOwnership [-Confirm] [-WhatIf] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet configures vRealize Operations Manager alerts.


NameTypeDescriptionRequired?Pipeline InputDefault Value
AlertOMAlert[]Specifies the alert you want to configure.trueTrue (ByValue)
CancelSwitchParameterCancels the alert and changes the alert status from active to inactive.trueFalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
ReleaseOwnershipSwitchParameterRemoves alert ownership from the assigned user.trueFalse
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
SuspendMinutesInt32Specifies the number of minutes for which the alert is suspended.trueFalse
TakeOwnershipSwitchParameterAssigns the alert ownership to the currently connected user.trueFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

The modified OMAlert objects



-------------------------- Example 1 --------------------------

$alert = Get-OMAlert -Id 'ID'
Set-OMAlert -Alert $alert -Cancel

Cancels the $alert alert.

-------------------------- Example 2 --------------------------

Set-OMAlert -Alert 'alert_name' -Server 'server_name' -TakeOwnership

Takes ownership for all alerts, filtered by alert name and server.

-------------------------- Example 3 --------------------------

$alert = Get-OMAlert -Id 'ID'
Set-OMAlert -Alert $alert -SuspendMinutes 1

Suspends the $alert alert for one minute.

Copyright © VMware, Inc. All rights reserved.