Set-OMAlert Command | Vmware PowerCLI Reference

Set-OMAlert

This cmdlet configures VMware Aria Operations alerts.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
Alert OMAlert[] named
  • pipeline
  • wildcards
Specifies the alert you want to configure.
required
Cancel SwitchParameter named
Cancels the alert and changes the alert status from active to inactive.
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.
Set-OMAlert
-Alert < OMAlert[] >
-ReleaseOwnership
[-Server < OMServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Alert OMAlert[] named
  • pipeline
  • wildcards
Specifies the alert you want to configure.
required
ReleaseOwnership SwitchParameter named
Removes alert ownership from the assigned user.
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.
Set-OMAlert
-Alert < OMAlert[] >
-SuspendMinutes < Int32 >
[-Server < OMServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Alert OMAlert[] named
  • pipeline
  • wildcards
Specifies the alert you want to configure.
required
SuspendMinutes Int32 named
Specifies the number of minutes for which the alert is suspended.
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.
Set-OMAlert
-Alert < OMAlert[] >
-TakeOwnership
[-Server < OMServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Alert OMAlert[] named
  • pipeline
  • wildcards
Specifies the alert you want to configure.
required
TakeOwnership SwitchParameter named
Assigns the alert ownership to the currently connected user.
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

$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 VMware Aria Operations server.

This cmdlet configures VMware Aria Operations alerts.

OMAlertDefinition

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

OMAlertSubType

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

OMAlertType

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