Set-OMAlert
This cmdlet configures vRealize Operations Manager alerts.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
OMAlert[] | named |
|
Specifies the alert you want to configure. | required |
|
SwitchParameter | named |
|
Cancels the alert and changes the alert status from active to inactive. | optional |
|
OMServer[] | named |
|
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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
OMAlert[] | named |
|
Specifies the alert you want to configure. | required |
|
SwitchParameter | named |
|
Removes alert ownership from the assigned user. | optional |
|
OMServer[] | named |
|
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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
OMAlert[] | named |
|
Specifies the alert you want to configure. | required |
|
Int32 | named |
|
Specifies the number of minutes for which the alert is suspended. | optional |
|
OMServer[] | named |
|
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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
OMAlert[] | named |
|
Specifies the alert you want to configure. | required |
|
SwitchParameter | named |
|
Assigns the alert ownership to the currently connected user. | optional |
|
OMServer[] | named |
|
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. |
Output
VMware.VimAutomation.vROps.Types.V1.OMAlert
Examples
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.
Related Commands
OMAlert
This cmdlet retrieves alerts from the specified vRealize Operations Manager server.
This cmdlet configures vRealize Operations Manager alerts.
OMAlertDefinition
This cmdlet retrieves alert definitions from the specified vRealize Operations Manager server.
OMAlertSubType
This cmdlet retrieves alert subtypes from the specified vRealize Operations Manager server.
OMAlertType
This cmdlet retrieves alert types from the specified vRealize Operations Manager server.
